Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/08/08 13:28
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 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 -(% class="box infomessage" %)49 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 84 + 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 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,63 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 126 + 127 +((( 97 97 { 98 - "agentId": "", ~/~/ идентификатор клиента (%%) 99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 - "isForeign": true/false, ~/~/ Иностранный контрагент 105 - "district": "string", ~/~/ округ 106 - "region": "string", ~/~/ регион 107 - "city": "string", ~/~/ город 108 - "inn": "string", ~/~/ ИНН клиента 109 - "kpp": "string", ~/~/ КПП клиента 110 - "address": "string", ~/~/ юридический адрес 111 - "addressFact": "string", ~/~/ фактический адрес 112 - "email": "string", ~/~/ почта 113 - "director": "string", ~/~/ ФИО руководителя 114 - "bankName": "string", ~/~/ Банк 115 - "bankBIK": "string", ~/~/ БИК 116 - "bankRS": "string", ~/~/ Номер счета 117 - "bankKS": "string" ~/~/ Корр. счет 118 - } 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 +))) 119 119 160 + 161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 182 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 211 + "agentId": "",(% style="color:#000000" %) (%%) 212 + "parentId": "", 213 + "name": "string", 214 + "fullName": "string", 215 + "agentInfoType": 0, 216 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 219 + 220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 227 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 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 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -349,9 +349,8 @@ 349 349 [ 350 350 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 351 ], 352 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 450 +{ 451 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 468 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 490 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 609 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 616 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 617 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 638 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 659 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 684 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,6 +682,8 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 747 += = 748 + 685 685 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 795 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -795,7 +795,7 @@ 795 795 { 796 796 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 797 797 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 798 - "deleted": true,860 + "deleted": false, 799 799 "extId": "string", 800 800 "name": "string", 801 801 "picture": "string", ... ... @@ -814,7 +814,7 @@ 814 814 { 815 815 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 816 816 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 817 - "deleted": true,879 + "deleted": false, 818 818 "extId": "string", 819 819 "name": "string", 820 820 "picture": "string", ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 892 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 893 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 894 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 895 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 896 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 898 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 899 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 900 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 901 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 902 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 903 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 904 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -836,7 +836,7 @@ 836 836 (% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 837 837 ))) 838 838 839 -(% style="color:#000000" %)Метод позволяет изменить статус пользователя, указанного в запросе.913 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 840 840 841 841 (% style="color:#000000" %)Метод запроса: **PUT** 842 842 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 959 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 960 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 961 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 962 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 963 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 965 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 966 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 967 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 968 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 969 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 970 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 971 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 972 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -889,7 +889,7 @@ 889 889 (% lang="en-US" %)**DELETE /api/v3/models/{Id}** 890 890 ))) 891 891 892 -(% style="color:#000000" %)Метод позволяет удалить пользователя. Метод позволяет удалитьпользователя, указанного в строке запроса.980 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 893 893 894 894 (% style="color:#000000" %)Метод запроса: **DELETE** 895 895 ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 992 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -930,6 +930,17 @@ 930 930 931 931 ((( 932 932 { 1021 + 1022 +((( 1023 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1024 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1025 +))) 1026 + 1027 +((( 1028 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1029 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1030 +))) 1031 + 933 933 "vehicleId": "", ~/~/ ID объекта 934 934 "name": "", ~/~/ Имя объекта 935 935 "imei": "", ~/~/ IMEI объекта ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1070 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1030,6 +1030,7 @@ 1030 1030 ], 1031 1031 "showInTooltip": true, ~/~/ Отображать в подсказке 1032 1032 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1126 + "color": "string", ~/~/ Код цвета датчиков 1033 1033 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1034 1034 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1035 1035 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,19 +1094,27 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1178 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", 1102 1102 "description": "string", 1103 1103 "additionalInfo": "string" 1104 - } 1105 - ] 1106 1106 1185 +((( 1107 1107 } 1187 + ], 1188 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1189 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1108 1108 ))) 1109 1109 1192 +((( 1193 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1194 +} 1195 + 1196 +))) 1197 +))) 1198 + 1110 1110 (% style="text-align:left" %) 1111 1111 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1112 1112 ... ... @@ -1113,6 +1113,75 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1205 + 1206 +== **Отправить команду на терминал** == 1207 + 1208 +(% class="box successmessage" %) 1209 +((( 1210 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1211 +))) 1212 + 1213 +Команда для отправки на тс. 1214 + 1215 +{ 1216 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1217 +"command": "", ~/~/ Текст отправляемой команды 1218 +"retries": "", ~/~/ Количество попыток отправки на терминал 1219 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1220 +} 1221 + 1222 +В ответ получаем cmdid 1223 + 1224 + 1225 +== **Получить ответ на отправленную на ТС команду** == 1226 + 1227 +(% class="box infomessage" %) 1228 +((( 1229 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1230 +))) 1231 + 1232 +Идентификатор команды: cmdId 1233 + 1234 +Запрос от терминала на ответ команды 1235 + 1236 +Пример ответ от терминала: 1237 + 1238 +ID= "" ~/~/ идентификатор объекта 1239 +Soft="" ~/~/ версия софта 1240 +GPS=4 ~/~/ тип трекера 1241 +Time=11:05:43 28.06.24 ~/~/ время запроса 1242 +Lat=45.056221 ~/~/ широта 1243 +Lon=39.035938 ~/~/ долгота 1244 +Speed=0.0 ~/~/ скорость 1245 +Course=181.4 ~/~/направление 1246 + 1247 +((( 1248 +== **Список отправленных объекту команд с ответами** == 1249 + 1250 +(% class="box infomessage" %) 1251 +((( 1252 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1253 +))) 1254 + 1255 +Идентификатор ТС: vehicleId 1256 + 1257 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1258 + 1259 +Пример ответа терминала 1260 + 1261 +[ 1262 +{ 1263 +"id": "", ~/~/ идентификатор пользователя 1264 +"commandText": "", ~/~/Текст команды. 1265 +"templateId": "", ~/~/Идентификатор шаблона 1266 +"updated": "", ~/~/ Время отправки 1267 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1268 +"answer": "", ~/~/ Ответ терминала. 1269 +"status": "" ~/~/ Статус отправки 1270 +} 1271 +] 1272 +))) 1273 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1132,6 +1132,11 @@ 1132 1132 1133 1133 (% style="color:#000000" %){ 1134 1134 1293 + 1294 +((( 1295 + "vehicleId": 0, ~/~/ ID ТС 1296 +))) 1297 + 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1364 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1227,6 +1227,7 @@ 1227 1227 ], 1228 1228 "showInTooltip": true, ~/~/ Отображать в подсказке 1229 1229 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1390 + "color": "string", ~/~/ код цвета датчиков 1230 1230 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1231 1231 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1232 1232 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1239,103 +1239,222 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1415 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1416 + 1417 +((( 1418 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1419 + { 1420 + "from": 0, ~/~/ С какого значения 1421 + "color": "string", ~/~/ Каким цветом 1422 + "text": "string" ~/~/ Текст подписи к этому интервалу 1423 + } 1424 + ] 1267 1267 } 1268 1268 ], 1427 +))) 1428 + 1429 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1430 + 1431 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1277 - } 1278 - ] 1434 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1435 + "name": "string", ~/~/ Наименование произвольного поля 1436 + "value": "string", ~/~/ Значение произвольного поля 1437 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1438 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1439 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1440 + 1441 +((( 1442 + } 1443 + ], 1444 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1445 +))) 1446 + 1447 +((( 1448 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1279 1279 } 1450 +))) 1280 1280 1452 + 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1456 +((( 1457 +((( 1458 +((( 1459 +{ 1460 + "vehicleId": 0, ~/~/ ID ТС 1461 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1462 + "name": "string", ~/~/ Имя объекта 1463 + "imei": "string", ~/~/ IMEI 1464 + "deviceTypeId": 0, ~/~/ ID типа устройства 1465 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1466 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1467 + "sim1": "string", ~/~/ SIM1 1468 + "sim2": "string", ~/~/ SIM2 1469 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1470 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1471 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1472 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1473 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1474 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1476 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1477 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1478 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1479 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1480 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1481 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1482 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1483 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1484 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1485 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1486 + "counters": { ~/~/ Dto для состояний счётчиков 1487 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1488 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1489 + "mileage": 0, ~/~/ Пробег 1490 + "motohours": 0 ~/~/ Моточасы 1491 + }, 1492 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1493 + "id": "string", ~/~/ CMSV6 Идентификатор 1494 + "enabled": true, ~/~/ Признак включения 1495 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1496 + "login": "string", ~/~/ CMSV6 имя учетной записи 1497 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1498 + }, 1499 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1500 + { 1501 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1502 + "enabled": true, ~/~/ Признак включения 1503 + "name": "string", ~/~/ Имя задания 1504 + "description": "string", ~/~/ Описание задания 1505 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1506 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1507 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1508 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1509 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1510 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1511 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1512 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 1514 + ], 1515 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1516 + { 1517 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1518 + "inputNumber": 0, ~/~/ № входа. 1519 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1520 + "comment": "string", ~/~/ Комментарий 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1522 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1523 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1524 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1525 + } 1526 + ], 1527 + "commandTemplates": [ ~/~/ Список шаблонов команд 1528 + { 1529 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1530 + "name": "string", ~/~/ Название шаблона команд 1531 + "command": "string", ~/~/ Команда на выполнение 1532 + "retries": 0 ~/~/ Лимит попыток отправки 1533 + } 1534 + ], 1535 + "sensors": [ ~/~/ Список датчиков 1536 + { 1537 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1538 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1539 + "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 1540 + "name": "string", ~/~/ Имя датчика 1541 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1542 + "inputNumber": 0, ~/~/ Номер входа 1543 + "pseudonym": "string", ~/~/ Псевдоним 1544 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1545 + "isInverted": true, ~/~/ Признак инверсии 1546 + "disabled": true, ~/~/ Датчик не участвует в обработке 1547 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1548 + "gradesTables": [ ~/~/ Тарировка 1549 + { 1550 + "grades": [ ~/~/ Таблицы тарировки 1551 + { 1552 + "input": 0, ~/~/ Вход 1553 + "output": 0 ~/~/ Выход 1554 + } 1555 + ], 1556 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1557 + } 1558 + ], 1559 + "showInTooltip": true, ~/~/ Отображение в подсказке 1560 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1561 + "color": "string", ~/~/ код цвета датчиков 1562 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1563 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1564 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1565 + "expr": "string", ~/~/ Выражение 1566 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1567 + "string" 1568 + ], 1569 + "customParams": { 1570 + "additionalProp1": "string", 1571 + "additionalProp2": "string", 1572 + "additionalProp3": "string" 1573 + }, 1574 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1575 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1576 + { 1577 + "from": 0, ~/~/ С какого значения 1578 + "color": "string", ~/~/ Каким цветом 1579 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% style="color:#000000" %)} 1581 +((( 1582 + "text": "string" ~/~/ Текст подписи к этому интервалу 1583 + } 1584 + ] 1585 + } 1586 + ], 1587 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1588 + "customFields": [ ~/~/ Список произвольных полей 1589 + { 1590 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1591 + "name": "string", ~/~/ Наименование произвольного поля 1592 + "value": "string", ~/~/ Значение произвольного поля 1593 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1594 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1595 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1596 + } 1597 + ], 1598 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1599 +} 1600 +))) 1601 +))) 1602 +))) 1325 1325 1604 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1332 1332 1611 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1612 + 1333 1333 (% class="box infomessage" %) 1334 1334 ((( 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1618 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1369,9 +1369,12 @@ 1369 1369 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1370 1370 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1371 1371 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1372 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1373 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1374 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1652 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1653 + "unitName": "string", ~/~/ Название подразделения (опционально) 1654 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1655 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1656 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1657 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1375 1375 } 1376 1376 1377 1377 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1378,8 +1378,14 @@ 1378 1378 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 -(% style="color:#000000" %){ 1664 +(% style="color:#000000" %)[ 1665 +{ 1382 1382 1667 +((( 1668 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1669 +))) 1670 + 1671 +((( 1383 1383 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта ... ... @@ -1405,9 +1405,21 @@ 1405 1405 "forClient": true, ~/~/ право на отображение у клиента 1406 1406 "forTooltip": false, ~/~/ право на отображение в подсказке 1407 1407 "forReport": false ~/~/ право на отображение в отчетах 1408 - }(%%) 1409 -(% style="color:#000000" %)} 1697 +))) 1410 1410 1699 +((( 1700 + } 1701 + ], 1702 + "vehicleGroups": [ ~/~/ Группы ТС 1703 + { 1704 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1705 + "name": "string" ~/~/ Наименование группы ТС 1706 + } 1707 + ] 1708 + } 1709 +] 1710 +))) 1711 + 1411 1411 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1412 1412 1413 1413 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1747 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,9 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1756 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1531,9 +1531,19 @@ 1531 1531 1532 1532 "drivers": [ ~/~/ Водители 1533 1533 { 1534 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 - "isDefault": true 1536 - } 1832 + 1833 +((( 1834 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1835 + "inputNumber": 0, ~/~/ № входа. 1836 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1837 + "comment": "string", ~/~/ Комментарий. 1838 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1839 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1840 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1841 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1842 +))) 1843 + 1844 + } 1537 1537 ], 1538 1538 "commandTemplates": [ ~/~/ Шаблон команды 1539 1539 { ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1854 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1570,6 +1570,11 @@ 1570 1570 ], 1571 1571 "showInTooltip": true, ~/~/ Отображать в подсказке 1572 1572 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1880 + 1881 +((( 1882 + "color": "string",** ~/~/ **Цвет датчика 1883 +))) 1884 + 1573 1573 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 1574 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 1575 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1582,95 +1582,225 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1910 + 1911 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1912 + { 1913 + "from": 0, ~/~/ С какого значения 1914 + "color": "string", ~/~/ Каким цветом 1915 + "text": "string" ~/~/ Текст подписи к этому интервалу 1916 + } 1917 + ] 1610 1610 } 1611 1611 ], 1920 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1921 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 1923 + { 1924 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1925 + "name": "string", ~/~/ Наименование произвольного поля 1926 + "value": "string", ~/~/ Значение произвольного поля 1927 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1928 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1929 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 - ] 1931 + 1932 +((( 1933 + ], 1934 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1935 +))) 1936 + 1622 1622 } 1623 1623 1939 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1942 +((( 1943 +{ 1944 + "vehicleId": 0, ~/~/ ID ТС 1945 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1946 + "name": "string", ~/~/ Имя объекта 1947 + "imei": "string", ~/~/ IMEI 1948 + "deviceTypeId": 0, ~/~/ ID типа устройства 1949 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1950 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1951 + "sim1": "string", ~/~/ SIM1 1952 + "sim2": "string", ~/~/ SIM2 1953 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1954 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1955 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1956 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1957 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1958 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1959 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1960 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1961 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1962 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1963 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1964 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1965 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1966 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1967 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1968 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1969 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1970 + "counters": { ~/~/ состояний счётчиков 1971 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1972 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1973 + "mileage": 0, ~/~/ Пробег 1974 + "motohours": 0 ~/~/ Моточасы 1975 + }, 1976 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1977 + "id": "string", ~/~/ CMSV6 Идентификатор 1978 + "enabled": true, ~/~/ Признак включения 1979 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1980 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 1982 + 1983 +((( 1984 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1985 + "login": "string", ~/~/ CMSV6 имя учетной записи 1986 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1987 + }, 1988 + "inspectionTasks": [ ~/~/ Задания на ТО 1989 + { 1990 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1991 + "enabled": true, ~/~/ Признак включения 1992 + "name": "string", ~/~/ Имя задания 1993 + "description": "string", ~/~/ Описание задания 1994 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1995 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1996 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1997 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1998 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1999 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2000 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2001 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2002 + } 2003 + ], 2004 + "drivers": [ ~/~/ Список водителей 2005 + { 2006 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2007 + "inputNumber": 0, ~/~/ № входа. 2008 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2009 + "comment": "string", ~/~/ Комментарий. 2010 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2011 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2012 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2013 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2014 + } 2015 + ], 2016 + "commandTemplates": [ ~/~/ Список шаблонов команд 2017 + { 2018 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2019 + "name": "string", ~/~/ Название шаблона команд 2020 + "command": "string", ~/~/ Команда на выполнение 2021 + "retries": 0 ~/~/ Лимит попыток отправки 2022 + } 2023 + ], 2024 + "sensors": [ ~/~/ Список датчиков 2025 + { 2026 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2027 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2028 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2029 +))) 2030 + 2031 +((( 2032 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2033 +))) 2034 + 2035 +((( 2036 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2037 +))) 2038 + 2039 +((( 2040 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2041 +))) 2042 + 2043 +((( 2044 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2045 +))) 2046 + 2047 +((( 2048 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2049 + "name": "string", ~/~/ Имя датчика 2050 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2051 +))) 2052 + 2053 +((( 2054 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2055 + "inputNumber": 0, ~/~/ Номер входа 2056 + "pseudonym": "string", ~/~/ Псевдоним 2057 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2058 + "isInverted": true, ~/~/ Признак инверсии 2059 + "disabled": true, ~/~/ Датчик не участвует в обработке 2060 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2061 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1657 - { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2063 + "grades": [ ~/~/ Таблицы тарировки 2064 + { 2065 + "input": 0, ~/~/ Вход 2066 + "output": 0 ~/~/ Выход 2067 + } 2068 + ], 2069 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1669 1669 } 2071 + ], 2072 + "showInTooltip": true, ~/~/ Отображение в подсказке 2073 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2075 +((( 2076 + "color": "string", ~/~/ цвет уведомлений 2077 +))) 1673 1673 2079 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2080 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2081 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2082 + "expr": "string", ~/~/ Выражение 2083 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2084 + "string" 2085 + ], 2086 + "customParams": { ~/~/ Дополнительные настройки 2087 + "additionalProp1": "string", 2088 + "additionalProp2": "string", 2089 + "additionalProp3": "string" 2090 + }, 2091 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2092 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2093 + { 2094 + "from": 0, ~/~/ С какого значения 2095 + "color": "string", ~/~/ Каким цветом 2096 + "text": "string" ~/~/ Текст подписи к этому интервалу 2097 + } 2098 + ] 2099 + } 2100 + ], 2101 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2102 + "customFields": [ ~/~/ Список произвольных полей 2103 + { 2104 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2105 + "name": "string", ~/~/ Наименование произвольного поля 2106 + "value": "string", ~/~/ Значение произвольного поля 2107 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2108 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2109 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2110 + } 2111 + ], 2112 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2113 +} 2114 +))) 2115 + 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% 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]]2154 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2160 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2184 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2231 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2232 + 2233 +(% class="box infomessage" style="text-align: left;" %) 2234 +((( 2235 +**POST /api/v3/terminalMessages/mapping** 2236 +))) 2237 + 2238 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2239 + 2240 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2241 + 2242 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2243 + 2244 +{ 2245 + "protocolType": 0, 2246 + "params": ["string"] 2247 +} 2248 + 2249 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2250 +|protocolType|ID типа протокола 2251 +|params|((( 2252 +Массив наименований параметров в сообщении 2253 +))) 2254 + 2255 +Ответ: 2256 + 2257 +{ 2258 + "protocolType": 0, 2259 + "mapping": { 2260 + "additionalProp1": { 2261 + "inputType": 0, 2262 + "inputNumber": 0 2263 + }, 2264 + "additionalProp2": { 2265 + "inputType": 0, 2266 + "inputNumber": 0 2267 + } 2268 + } 2269 +} 2270 + 2271 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2272 +|protocolType|Тип протокола 2273 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2274 +|inputNumber|((( 2275 +Номер входа 2276 +))) 2277 + 2278 +(% class="wikigeneratedid" %) 2279 +Перечень 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/]] 2280 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2305 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2306 +|vehicleId|ID объекта 2307 +|from|Дата и время начала периода запроса 2308 +|to|Дата и время окончания периода запроса 2309 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2316 + "deviceTime": "2023-11-29T07:40:44.052Z", 2317 + "serverTime": "2023-11-29T07:40:44.052Z", 2318 + "speed": 0, 2319 + "altitude": 0, 2320 + "latitude": 0, 2321 + "longitude": 0, 2322 + "satellites": 0, 2323 + "course": 0, 2324 + "voltage": 0, 2325 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2330 + "photoCount": 0, 2331 + "lbsCorrectedCoords": true, 2332 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2338 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2339 +|deviceTime|Время сообщения терминала 2340 +|serverTime|Время когда сообщение поступило на сервер 2341 +|speed|Скорость 2342 +|altitude|Высота над уровнем моря 2343 +|latitude|Широта 2344 +|longitude|Долгота 2345 +|satellites|Кол-во спутников 2346 +|course|Курс 2347 +|voltage|Бортовое напряжение 2348 +|parameters|Список параметров и их значений 2349 +|photoCount|Количество фото 2350 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2351 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1915,7 +1915,7 @@ 1915 1915 Тело запроса: 1916 1916 1917 1917 { 1918 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2372 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1919 1919 "vehicleIds": [0], ~/~/ Список ID объектов 1920 1920 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1921 1921 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -1932,10 +1932,14 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2389 + "mileage": 0, ~/~/ Пробег за период, километры 2390 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2391 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2392 + "motohours": 0, ~/~/ Моточасы за период, секунды 2393 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2394 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2395 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2396 + 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1958,7 +1958,7 @@ 1958 1958 Тело запроса: 1959 1959 1960 1960 { 1961 - "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2419 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 1962 1962 "vehicleIds": [0], ~/~/ Список ID объектов 1963 1963 "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 1964 1964 "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода ... ... @@ -1977,13 +1977,23 @@ 1977 1977 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1978 1978 "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 1979 1979 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2438 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2439 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 1980 1980 "fuelConsumption": 0, ~/~/ Расход топлива 1981 1981 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2442 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2443 + 1982 1982 } 1983 1983 ] 1984 1984 } 1985 1985 ] 1986 1986 2449 +(% class="box warningmessage" %) 2450 +((( 2451 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2452 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2453 +))) 2454 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2018,7 +2018,8 @@ 2018 2018 "model": "string", ~/~/ Модель объекта 2019 2019 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 2020 { 2021 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2489 + "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 2490 + 2022 2022 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 2023 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 2024 "valueFuel": 0, ~/~/ Количество ... ... @@ -2029,6 +2029,120 @@ 2029 2029 } 2030 2030 ] 2031 2031 2501 + 2502 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2503 + 2504 +(% class="box infomessage" %) 2505 +((( 2506 +**POST /api/v3/vehicles/moveStop** 2507 +))) 2508 + 2509 +Метод запроса: **POST** 2510 + 2511 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2512 + 2513 +В заголовках запроса: X-Auth: Токен авторизации 2514 + 2515 + 2516 +Тело запроса: 2517 + 2518 +{ 2519 + "vehicleIds": [ ], ~/~/ Список ID объектов 2520 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2521 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2522 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2523 +} 2524 + 2525 +Ответ: 2526 + 2527 +[ 2528 + { 2529 + "vehicleId": 0, ~/~/ ID объекта 2530 + "vehicleName": "string", ~/~/ Имя объекта 2531 + "moves": [ ~/~/ Событие движения 2532 + { 2533 + "mileage": 0, ~/~/ Пробег, км 2534 + "eventId": 0, ~/~/ Идентификатор события 2535 + "eventName": "string", ~/~/ Название события 2536 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2537 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2538 + "duration": 0 ~/~/ Продолжительность события, секунд 2539 + } 2540 + ], 2541 + "stops": [ ~/~/ События стоянок 2542 + { 2543 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2544 + "eventId": 0, ~/~/ Идентификатор события 2545 + "eventName": "string", ~/~/ Название события 2546 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2547 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2548 + "duration": 0 ~/~/ Продолжительность события, секунд 2549 + } 2550 + ] 2551 + } 2552 +] 2553 + 2554 + 2555 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2556 + 2557 +(% class="box infomessage" %) 2558 +((( 2559 +**POST /api/v3/vehicles/getlastdata** 2560 +))) 2561 + 2562 +Метод запроса: **POST** 2563 + 2564 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2565 + 2566 +В заголовках запроса: X-Auth: Токен авторизации 2567 + 2568 + 2569 +В массиве указываем id объектов через запятую 2570 + 2571 +Ответ: 2572 + 2573 +[ 2574 + { 2575 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2576 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2577 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2578 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2579 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2580 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2581 + "speed": 31, ~/~/ Скорость объекта 2582 + "course": 116, ~/~/ Курс движения [0;360] 2583 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2584 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2585 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2586 + "geozones": [ ~/~/ Сведения по геозонам. 2587 + { 2588 + "id": 10225647, ~/~/ ID Геозоны 2589 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2590 + }, 2591 + { 2592 + "id": 10282875, ~/~/ ID Геозоны 2593 + "name": "Ё2" ~/~/ Наименование геозоны 2594 + }, 2595 + { 2596 + "id": 10226240, ~/~/ ID Геозоны 2597 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2598 + }, 2599 + { 2600 + "id": 9747869, ~/~/ ID Геозоны 2601 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2602 + }, 2603 + { 2604 + "id": 10221123, ~/~/ ID Геозоны 2605 + "name": "53r" ~/~/ Наименование геозоны 2606 + }, 2607 + { 2608 + "id": 10197638, ~/~/ ID Геозоны 2609 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2610 + } 2611 + ] 2612 + } 2613 + 2614 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2157,6 +2157,35 @@ 2157 2157 } 2158 2158 ] 2159 2159 2743 + 2744 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2745 + 2746 +(% class="box successmessage" %) 2747 +((( 2748 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2749 +))) 2750 + 2751 +(% style="color:#000000" %)Метод запроса: **PUT** 2752 + 2753 +Пример запроса: 2754 + 2755 +((( 2756 +{ 2757 + "id": 0, ~/~/ Идентификатор объекта геозоны 2758 + "name": "string", ~/~/ Наименование объекта геозоны 2759 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2760 + "description": "string", ~/~/ Описание объекта геозоны 2761 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2762 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2763 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2764 +} 2765 +))) 2766 + 2767 + 2768 +Пример ответа: 2769 + 2770 +200 ~/~/ Success 2771 + 2160 2160 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2161 2161 2162 2162 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2188,7 +2188,7 @@ 2188 2188 "id": 0, ~/~/ ID уведомления 2189 2189 "name": "string", ~/~/ Название уведомления 2190 2190 "active": true, ~/~/ Состояние true - активен, false - деактивирован 2191 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2803 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2192 2192 "userId": "", ~/~/ Пользователь, создавший уведомление 2193 2193 "parentId": "", ~/~/ Идентификатор клиента 2194 2194 "parentName": "string" ~/~/ Имя клиента ... ... @@ -2195,6 +2195,155 @@ 2195 2195 } 2196 2196 ] 2197 2197 2810 + 2811 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2812 + 2813 +(% class="box infomessage" %) 2814 +((( 2815 +**POST /api/v3/notifications** 2816 +))) 2817 + 2818 +Метод запроса **POST** 2819 + 2820 +(% style="text-align: left;" %) 2821 +(% style="color:#000000" %)Пример запроса 2822 + 2823 +((( 2824 +{ 2825 + "id": 0, ~/~/ ID правила 2826 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2827 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2828 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2829 + "name": "string", ~/~/ Имя правила 2830 + "active": true, ~/~/ Активность правила 2831 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2832 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2833 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2834 + ], 2835 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2836 + 0 2837 + ], 2838 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2839 + 0 2840 + ], 2841 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2842 + 0 2843 + ], 2844 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2845 + "additionalProp1": "string", 2846 + "additionalProp2": "string", 2847 + "additionalProp3": "string" 2848 + }, 2849 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2850 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2851 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2852 + ], 2853 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2854 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2855 + "string" 2856 + ], 2857 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2858 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2859 + { 2860 + "id": 0, ~/~/ Идентификатор участника чата. 2861 + "info": "string" ~/~/ Дополнительные сведения. 2862 + } 2863 + ], 2864 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2865 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2866 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2867 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2868 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2869 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2870 + "timezone": 0, ~/~/ часовой пояс 2871 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2872 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2873 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2874 + { 2875 + "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 - Срок действия правила истек 2876 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2877 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2878 + "additionalProp1": "string", 2879 + "additionalProp2": "string", 2880 + "additionalProp3": "string" 2881 + } 2882 + } 2883 + ] 2884 +} 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +((( 2892 + 2893 +))) 2894 + 2895 +Ответ: 2896 + 2897 +{ 2898 + "id": 0, ~/~/ ID правила 2899 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2900 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2901 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2902 + "name": "string", ~/~/ Имя правила 2903 + "active": true, ~/~/ Активность правила 2904 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2905 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2906 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2907 + ], 2908 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2909 + 0 2910 + ], 2911 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2912 + 0 2913 + ], 2914 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2915 + 0 2916 + ], 2917 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2918 + "additionalProp1": "string", 2919 + "additionalProp2": "string", 2920 + "additionalProp3": "string" 2921 + }, 2922 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2923 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2924 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2925 + ], 2926 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2927 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2928 + "string" 2929 + ], 2930 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2931 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2932 + { 2933 + "id": 0, ~/~/ Идентификатор участника чата. 2934 + "info": "string" ~/~/ Дополнительные сведения. 2935 + } 2936 + ], 2937 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2938 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2939 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2940 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2941 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2942 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2943 + "timezone": 0, ~/~/ часовой пояс 2944 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2945 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2946 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2947 + { 2948 + "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 - Срок действия правила истек 2949 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2950 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2951 + "additionalProp1": "string", 2952 + "additionalProp2": "string", 2953 + "additionalProp3": "string" 2954 + } 2955 + } 2956 + ] 2957 +} 2958 + 2198 2198 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2199 2199 2200 2200 (% class="box infomessage" %) ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 3100 + 3101 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3102 + 3103 +(% class="box warningmessage" %) 3104 +((( 3105 +**PUT** /api/v3/notifications/prolongation 3106 +))) 3107 + 3108 +Метод позволяет продлить уведомления. 3109 + 3110 +Метод запроса **PUT** 3111 + 3112 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3113 + 3114 +В заголовках запроса: X-Auth: Токен авторизации. 3115 + 3116 +Тело запроса: 3117 + 3118 +[ 3119 + 3120 +0 3121 + 3122 +] 3123 + 3124 +где 0 идентификатор ids. 3125 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3717 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3718 + 3719 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3720 + 3721 +(% class="box infomessage" %) 3722 +((( 3723 +**POST /api/v3/Trailers** 3724 +))) 3725 + 3726 +Пример запроса: 3727 + 3728 +{ 3729 + "startDate": "2023-11-14T10:48:03.671Z", 3730 + "endDate": "2023-11-14T10:48:03.671Z", 3731 + "ids": [ 0 ], 3732 + "timezone": 0 3733 +} 3734 + 3735 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3736 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3737 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3738 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3739 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3740 + 3741 +Пример ответа: 3742 + 3743 +[ 3744 + { 3745 + "SD": "2023-11-14T10:48:03.717Z", 3746 + "ED": "2023-11-14T10:48:03.717Z", 3747 + "id": 0, 3748 + "SLat": 0, 3749 + "SLon": 0, 3750 + "ELat": 0, 3751 + "ELon": 0, 3752 + "mileage": 0 3753 + "Duration": 0 3754 + "Address": "string", 3755 + "Address2": "string", 3756 + "name": "string", 3757 + "rid": "string", 3758 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3759 + "trailer": { 3760 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3761 + "Number": "string", 3762 + "Description": "string", 3763 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3764 + "ExternalID": "string", 3765 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3766 + "CreateTime": "2023-11-14T10:48:03.717Z", 3767 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3768 + "IsDeleted": true 3769 + }, 3770 + "filesCount": 0, 3771 + } 3772 +] 3773 + 3774 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3775 +|SD|Дата и время начала события 3776 +|ED|Дата и время окончания события 3777 +|id|ID объекта 3778 +|SLat|Широта начальной координаты 3779 +|SLon|Долгота начальной координаты 3780 +|ELat|Широта конечной координаты 3781 +|ELon|Долгота конечной координаты 3782 +|mileage|Пробег 3783 +|Duration|Продолжительность 3784 +|Address|Адрес начального местоположения 3785 +|Address2|Адрес конечного местоположения 3786 +|name|Имя радиометки 3787 +|rid|Номер радиометки 3788 +|rguid|ID радиометки 3789 +|trailer|Информация об агрегате 3790 +|ModelGuid|ID агрегата 3791 +|Number|Название/номер агрегата 3792 +|Description|Текст примечания агрегата 3793 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,18 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3815 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3821 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3822 +|parentId|ID клиента 3823 +|name|Название карты-метки 3824 +|number|Номер 3825 +|period|Период запросов в секундах (работает только для агрегатов) 3826 +|id|ID карты-метки 2958 2958 2959 2959 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2960 2960 ... ... @@ -2971,13 +2971,18 @@ 2971 2971 { 2972 2972 "name": "string", 2973 2973 "number": 0, 2974 - "period": 0, ~/~/ Частота трансляции радиометки3843 + "period": 0, 2975 2975 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 2976 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2977 - "deleted": true 2978 2978 } 2979 2979 ] 2980 2980 3849 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3850 +|name|Название карты-метки 3851 +|number|Номер 3852 +|period|Период запросов в секундах (работает только для агрегатов) 3853 +|id|ID карты-метки 3854 +|parentId|ID клиента 2981 2981 2982 2982 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2983 2983 ... ... @@ -2993,7 +2993,6 @@ 2993 2993 "number": 0, 2994 2994 "period": 0, 2995 2995 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2996 - "deleted": true 2997 2997 } 2998 2998 2999 2999 Ответ: ... ... @@ -3004,9 +3004,14 @@ 3004 3004 "period": 0, 3005 3005 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 3006 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3007 - "deleted": true 3008 3008 } 3009 3009 3882 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3883 +|name|Название карты-метки 3884 +|number|Номер 3885 +|period|Период запросов в секундах (работает только для агрегатов) 3886 +|id|ID карты-метки 3887 +|parentId|ID клиента 3010 3010 3011 3011 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3012 3012 ... ... @@ -3023,7 +3023,6 @@ 3023 3023 "period": 0, 3024 3024 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3025 3025 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3026 - "deleted": true 3027 3027 } 3028 3028 3029 3029 Ответ: ... ... @@ -3034,9 +3034,14 @@ 3034 3034 "period": 0, 3035 3035 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3036 3036 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3037 - "deleted": true 3038 3038 } 3039 3039 3916 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3917 +|name|Название карты-метки 3918 +|number|Номер 3919 +|period|Период запросов в секундах (работает только для агрегатов) 3920 +|id|ID карты-метки 3921 +|parentId|ID клиента 3040 3040 3041 3041 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3042 3042 ... ... @@ -3045,7 +3045,7 @@ 3045 3045 **DELETE /api/v3/Rfids/{rfidGuid}** 3046 3046 ))) 3047 3047 3048 -Передаем параметр rfidGuid - идентификатор карты-метки 3930 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3049 3049 3050 3050 Ответ: 3051 3051 ... ... @@ -3052,6 +3052,2768 @@ 3052 3052 Success 3053 3053 3054 3054 3937 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3938 + 3939 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3940 + 3941 +(% class="box infomessage" %) 3942 +((( 3943 +**GET /api/v3/Billing/client/balance/{clientId}** 3944 +))) 3945 + 3946 +Параметр запроса: **clientId **- идентификатор клиента. 3947 + 3948 +Ответ: 3949 + 3950 +{ 3951 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3952 + "Balance": 0 3953 +} 3954 + 3955 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3956 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3957 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3958 + 3959 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3960 + 3961 +(% class="box infomessage" %) 3962 +((( 3963 +**GET /api/v3/Billing/client/constraint/{clientId}** 3964 +))) 3965 + 3966 +Параметр запроса: **clientId **- идентификатор клиента. 3967 + 3968 +Ответ: 3969 + 3970 +{ 3971 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3972 + "CalculationType": 0, 3973 + "PermissibleBalance": 0, 3974 + "DefermentDays": 0, 3975 + "SendUiNotifications": true, 3976 + "SendEmailNotifications": true, 3977 + "IsPrivate": true, 3978 +} 3979 + 3980 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3981 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3982 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3983 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3984 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3985 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3986 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3987 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3988 + 3989 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3990 + 3991 +(% class="box infomessage" %) 3992 +((( 3993 +**GET /api/v3/Billing/client/plan/{clientId}** 3994 +))) 3995 + 3996 +Параметры запроса: 3997 + 3998 +**clientId **- идентификатор клиента. 3999 + 4000 +**planId **- идентификатор тарифного плана. 4001 + 4002 +Ответ: 4003 + 4004 +{ 4005 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4006 + "Plan": { **~/~/ Описание тарифного плана** 4007 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4008 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4009 + "Name": "string", 4010 + "IsArchived": true, 4011 + "Constraint": { 4012 + "CalculationType": 0, 4013 + "PermissibleBalance": 0, 4014 + "DefermentDays": 0 4015 + }, 4016 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 4017 + { 4018 + "Feature": "string", 4019 + "IsFactual": true, 4020 + "Limit": 0, 4021 + "Price": 0, 4022 + "PeriodValue": 0, 4023 + "PeriodType": 0 4024 + } 4025 + ] 4026 + }, 4027 + "DebitDate": "2023-10-18T12:46:24.213Z", 4028 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 4029 + { 4030 + "Feature": "string", 4031 + "IsEnabled": true, 4032 + "IsPrivate": true, 4033 + "IsFactual": true, 4034 + "Limit": 0, 4035 + "Price": 0, 4036 + "DebitDate": "2023-10-18T12:46:24.213Z", 4037 + "PeriodValue": 0, 4038 + "PeriodType": 0 4039 + } 4040 + ] 4041 +} 4042 + 4043 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4044 +|ClientId|Идентификатор клиента 4045 +|Id|Идентификатор тарифного плана 4046 +|OwnerId|Идентификатор клиента-владельца 4047 +|Name|Наименование тарифного плана 4048 +|IsArchived|Признак, определяющий архивный тарифный план 4049 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4050 +|PermissibleBalance|Допустимый баланс 4051 +|DefermentDays|Отсрочка, количество дней 4052 +|Feature|Код услуги 4053 +|IsEnabled|Признак, определяющий активирована ли услуга 4054 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4055 +|IsFactual|Признак, определяющий расчёт по факту 4056 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4057 +|Price|Цена за единицу. 4058 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4059 +|PeriodValue|Значение периода. 4060 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4061 + 4062 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 4063 + 4064 +(% class="box infomessage" %) 4065 +((( 4066 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4067 +))) 4068 + 4069 +Параметр запроса: **clientId **- идентификатор клиента. 4070 + 4071 +Ответ: 4072 + 4073 +[ 4074 + { 4075 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4076 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4077 + "Name": "string", 4078 + "IsArchived": true, 4079 + "Constraint": { 4080 + "CalculationType": 0, 4081 + "PermissibleBalance": 0, 4082 + "DefermentDays": 0 4083 + }, 4084 + "Features": [ 4085 + { 4086 + "Feature": "string", 4087 + "IsFactual": true, 4088 + "Limit": 0, 4089 + "Price": 0, 4090 + "PeriodValue": 0, 4091 + "PeriodType": 0 4092 + } 4093 + ] 4094 + } 4095 +] 4096 + 4097 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4098 +|ClientId|Идентификатор клиента 4099 +|Id|Идентификатор тарифного плана 4100 +|OwnerId|Идентификатор клиента-владельца 4101 +|Name|Наименование тарифного плана 4102 +|IsArchived|Признак, определяющий архивный тарифный план 4103 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4104 +|PermissibleBalance|Допустимый баланс 4105 +|DefermentDays|Отсрочка, количество дней 4106 +|Feature|Код услуги 4107 +|IsFactual|Признак, определяющий расчёт по факту 4108 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4109 +|Price|Цена за единицу. 4110 +|PeriodValue|Значение периода. 4111 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4112 + 4113 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 4114 + 4115 +(% class="box infomessage" %) 4116 +((( 4117 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4118 +))) 4119 + 4120 +Параметр запроса: **clientId **- идентификатор клиента. 4121 + 4122 +Ответ: 4123 + 4124 +[ 4125 + { 4126 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4127 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4128 + "Name": "string", 4129 + "IsArchived": true, 4130 + "Constraint": { 4131 + "CalculationType": 0, 4132 + "PermissibleBalance": 0, 4133 + "DefermentDays": 0 4134 + }, 4135 + "Features": [ 4136 + { 4137 + "Feature": "string", 4138 + "IsFactual": true, 4139 + "Limit": 0, 4140 + "Price": 0, 4141 + "PeriodValue": 0, 4142 + "PeriodType": 0 4143 + } 4144 + ] 4145 + } 4146 +] 4147 + 4148 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4149 +|ClientId|Идентификатор клиента 4150 +|Id|Идентификатор тарифного плана 4151 +|OwnerId|Идентификатор клиента-владельца 4152 +|Name|Наименование тарифного плана 4153 +|IsArchived|Признак, определяющий архивный тарифный план 4154 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4155 +|PermissibleBalance|Допустимый баланс 4156 +|DefermentDays|Отсрочка, количество дней 4157 +|Feature|Код услуги 4158 +|IsFactual|Признак, определяющий расчёт по факту 4159 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4160 +|Price|Цена за единицу. 4161 +|PeriodValue|Значение периода. 4162 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4163 + 4164 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4165 + 4166 +(% class="box warningmessage" %) 4167 +((( 4168 +**PUT /api/v3/Billing/client/balance** 4169 +))) 4170 + 4171 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4172 + 4173 +Тело запроса: 4174 + 4175 +{ 4176 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4177 + "Balance": 0 ~/~/ Значение баланса. 4178 +} 4179 + 4180 +Ответ: Success 4181 + 4182 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4183 + 4184 +(% class="box warningmessage" %) 4185 +((( 4186 +**PUT /api/v3/billing/client/balance/deposit** 4187 +))) 4188 + 4189 +Создает операцию **Пополнение **с указанной суммой 4190 + 4191 +Тело запроса: 4192 + 4193 +((( 4194 +{ 4195 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4196 + "amount": 0 ~/~/ Сумма пополнения баланса 4197 +} 4198 +))) 4199 + 4200 +((( 4201 + 4202 +))) 4203 + 4204 +Ответ: Success 4205 + 4206 +((( 4207 +{ 4208 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4209 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4210 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4211 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4212 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4213 + "Description": "string" ~/~/ Описание корректировки. 4214 +} 4215 +))) 4216 + 4217 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4218 + 4219 +Создает операцию **Списание **с указанной суммой 4220 + 4221 +(% class="box warningmessage" %) 4222 +((( 4223 +**PUT /api/v3/billing/client/balance/withdraw** 4224 +))) 4225 + 4226 +Тело запроса: 4227 + 4228 +((( 4229 +{ 4230 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4231 + "amount": 0 ~/~/ Сумма списания с баланса 4232 +} 4233 +))) 4234 + 4235 +Ответ: Success 4236 + 4237 +((( 4238 +{ 4239 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4240 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4241 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4242 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4243 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4244 + "Description": "string" ~/~/ Описание корректировки 4245 +} 4246 +))) 4247 + 4248 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4249 + 4250 +(% class="box warningmessage" %) 4251 +((( 4252 +**PUT /api/v3/Billing/client/constraint** 4253 +))) 4254 + 4255 +Тело запроса: 4256 + 4257 +((( 4258 +{ 4259 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4260 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4261 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4262 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4263 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4264 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4265 +} 4266 +))) 4267 + 4268 +((( 4269 + 4270 +))) 4271 + 4272 +Ответ: Success 4273 + 4274 +((( 4275 +{ 4276 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4277 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4278 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4279 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4280 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4281 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4282 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4283 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4284 +} 4285 +))) 4286 + 4287 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4288 + 4289 +(% class="box warningmessage" %) 4290 +((( 4291 +**PUT /api/v3/Billing/client/plan** 4292 +))) 4293 + 4294 +Тело запроса: 4295 + 4296 +{ 4297 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4298 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4299 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4300 + { 4301 + "Feature": "string", ~/~/ Код услуги. 4302 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4303 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4304 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4305 + "Price": 0, ~/~/ Цена за единицу. 4306 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4307 + "PeriodValue": 0, ~/~/ Значение периода. 4308 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4309 + } 4310 + ] 4311 +} 4312 + 4313 + 4314 +Ответ: Success 4315 + 4316 +((( 4317 +{ 4318 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4319 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4320 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4321 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4322 + "Name": "string", ~/~/ Наименование. 4323 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4324 + "Constraint": { ~/~/ Ограничения по тарифу 4325 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4326 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4327 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4328 + }, 4329 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4330 + { 4331 + "Feature": "string", ~/~/Код услуги. 4332 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4333 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4334 + "Price": 0, ~/~/ Цена за единицу. 4335 + "PeriodValue": 0, ~/~/ Значение периода. 4336 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4337 + } 4338 + ], 4339 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4340 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4341 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4342 + }, 4343 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4344 + { 4345 + "Feature": "string", ~/~/ Код услуги. 4346 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4347 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4348 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4349 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4350 + "Price": 0, ~/~/ Цена за единицу. 4351 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4352 + "PeriodValue": 0, ~/~/ Значение периода. 4353 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4354 + "Quantity": 0 ~/~/ Количество использования услуги. 4355 + } 4356 + ] 4357 +} 4358 +))) 4359 + 4360 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4361 + 4362 +(% class="box warningmessage" %) 4363 +((( 4364 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4365 +))) 4366 + 4367 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4368 + 4369 +(% class="box infomessage" %) 4370 +((( 4371 +**POST /api/v3/vehicles/import/{agentId}** 4372 +))) 4373 + 4374 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4375 + 4376 +В пути указывается **agentId** - id клиента. 4377 + 4378 +**Заголовок** 4379 + 4380 +**X-Auth: [токен авторизации]** 4381 + 4382 +**Параметры** 4383 + 4384 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4385 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4386 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4387 + 4388 +В теле использовать тип **form-data,** тип значения** file** 4389 + 4390 +**Ключи** 4391 + 4392 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4393 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4394 +|csv|В значении передаем файл датчиков, формат **csv** 4395 + 4396 +Ответ: 4397 + 4398 +{ 4399 + "vehicleId": 0, 4400 + "name": "string", 4401 + "errors": ["string"] 4402 +} 4403 + 4404 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4405 +|vehicleId|ID созданного объекта 4406 +|name|Имя созданного объекта 4407 +|errors|Ошибки и их описание 4408 + 4409 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4410 + 4411 +(% class="box infomessage" %) 4412 +((( 4413 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4414 +))) 4415 + 4416 +(% class="wikigeneratedid" %) 4417 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4418 + 4419 +(% class="wikigeneratedid" %) 4420 +В пути указывается **vehicleId **- id объекта. 4421 + 4422 +**Заголовок** 4423 + 4424 +**X-Auth: [токен авторизации]** 4425 + 4426 +В теле использовать тип **form-data.** 4427 + 4428 +Ключи: 4429 + 4430 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4431 +|**history**|В значении передавать файл с историей 4432 + 4433 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4434 + 4435 +Ответ: 4436 + 4437 +{ 4438 + "results": [ 4439 + { 4440 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4441 + "vehicleId": 0, 4442 + "errors": [ 4443 + "string" 4444 + ], 4445 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4446 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4447 + "producedCount": 0, 4448 + "msgCount": 0 4449 + } 4450 + ] 4451 +} 4452 + 4453 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4454 +|results|Результаты импорта в разрезе ТС 4455 +|vehicleGuid|Guid ТС 4456 +|vehicleId|ID ТС 4457 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4458 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4459 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4460 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4461 +|msgCount|Кол-во обработанных сообщений всего 4462 + 4463 +== **Импортировать историю ТС (Асинхронный запрос)** == 4464 + 4465 +(% class="box successmessage" %) 4466 +((( 4467 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4468 +))) 4469 + 4470 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4471 + 4472 +Метод запроса: **POST** 4473 + 4474 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4475 + 4476 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4477 + 4478 + 4479 +Ответ: 4480 + 4481 +{ 4482 + 4483 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4484 + 4485 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4486 + 4487 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4488 + 4489 + "Message": "string", ~/~/ Информация о выполнении запроса 4490 + 4491 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4492 + 4493 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4494 + 4495 + "Data": "string" ~/~/ Данные 4496 + 4497 +} 4498 + 4499 + 4500 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4501 + 4502 +(% class="box infomessage" %) 4503 +((( 4504 +**GET /api/v3/vehicles/import/history/status** 4505 +))) 4506 + 4507 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4508 + 4509 +Ответ: 4510 + 4511 +{ 4512 + "activity": true, 4513 + "progress": 0, 4514 + "message": "string" 4515 +} 4516 + 4517 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4518 +**Параметр** 4519 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4520 +**Описание** 4521 +))) 4522 +|((( 4523 +activity 4524 +)))|((( 4525 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4526 +))) 4527 +|((( 4528 +progress 4529 +)))|((( 4530 +Guid ТС 4531 +))) 4532 + 4533 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4534 + 4535 +(% class="box infomessage" %) 4536 +((( 4537 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4538 +))) 4539 + 4540 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4541 + 4542 +Метод запроса: **GET** 4543 + 4544 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4545 + 4546 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4547 + 4548 + 4549 +Ответ: 4550 + 4551 +{ 4552 + 4553 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4554 + 4555 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4556 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4557 + 4558 + "Message": "string", ~/~/ Информация о выполнении запроса 4559 + 4560 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4561 + 4562 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4563 + 4564 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4565 + 4566 + "Data": "string" ~/~/ Данные 4567 + 4568 +} 4569 + 4570 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4571 + 4572 +(% class="box infomessage" %) 4573 +((( 4574 +**POST /api/v3/vehicles/export** 4575 +))) 4576 + 4577 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4578 + 4579 +Тело запроса: 4580 + 4581 +[ 4582 + id 4583 +] 4584 + 4585 +Ответ: Success 200, получаете файлы с настройками. 4586 + 4587 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4588 + 4589 +(% class="box infomessage" %) 4590 +((( 4591 +**POST /api/v3/vehicles/export/history** 4592 +))) 4593 + 4594 +Метод возвращает список сообщений терминала объекта за выбранный период. 4595 + 4596 +Тело запроса: 4597 + 4598 +{ 4599 + "vehicleId": 0, 4600 + "asArchive": true, 4601 + "from": "2023-09-27T12:17:45.973Z", 4602 + "to": "2023-09-27T12:17:45.973Z" 4603 +} 4604 + 4605 +Ответ: 4606 + 4607 +Получаете файл. Сообщение: Code 200/Success 4608 + 4609 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4610 +|vehicleId|ID объекта 4611 +|asArchive|true - Архивировать файл, False - не архивировать 4612 +|from|Дата и время начала запроса 4613 +|to|Дата и время окончания запроса 4614 + 4615 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4616 + 4617 +(% class="box infomessage" %) 4618 +((( 4619 +**GET /api/v3/vehicles/export/history/status** 4620 +))) 4621 + 4622 +Метод возвращает список сообщений терминала объекта за выбранный период. 4623 + 4624 +Ответ: 4625 + 4626 +{ 4627 + "activity": true, 4628 + "progress": 0, 4629 + "message": "string" 4630 +} 4631 + 4632 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4633 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4634 +|progress|Прогресс экспорта, от 0 до 100% 4635 +|message|Текст описывающий статус 4636 + 4637 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4638 + 4639 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4640 + 4641 +(% class="box infomessage" %) 4642 +((( 4643 +**POST /api/v3/EcoDriving/rating** 4644 +))) 4645 + 4646 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4647 + 4648 +Тело запроса: 4649 + 4650 +{ 4651 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4652 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4653 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4654 +} 4655 + 4656 +Ответ: 4657 + 4658 +{ 4659 + "items": [ ~/~/ Список в разрезе ТС 4660 + { 4661 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4662 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4663 + "vehicleId": 0, ~/~/ ID ТС 4664 + "vehicleName": "string", ~/~/ Название ТС 4665 + "vehicleModel": "string", ~/~/ Модель ТС 4666 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4667 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4668 + "totalViolations": 0, ~/~/ Нарушений всего 4669 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4670 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4671 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4672 + "brakingViolations": 0, ~/~/ Нарушений торможения 4673 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4674 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4675 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4676 + }, 4677 + 4678 +((( 4679 + 4680 +))) 4681 + 4682 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4683 + "mileage": 0, ~/~/ Пробег, м 4684 + "tripsCount": 0, ~/~/ Кол-во рейсов 4685 + "trips": [ ~/~/ Информация по рейсу 4686 + { 4687 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4688 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4689 + "violationsCount": 0, ~/~/ Всего нарушений 4690 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4691 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4692 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4693 + "brakingViolations": 0, ~/~/ Нарушений торможения 4694 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4695 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4696 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4697 + }, 4698 + 4699 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4700 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4701 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4702 + "mileage": 0, ~/~/ Пробег, м 4703 + "motohours": 0, ~/~/ Моточасы, секунды 4704 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4705 + "startAddress": "string", ~/~/ Адрес начала рейса 4706 + "endAddress": "string", ~/~/ Адрес конца рейса 4707 + "drivers": [ ~/~/ Список водителей 4708 + { 4709 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4710 + "driverName": "string", ~/~/ФИО водителя 4711 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4712 + } 4713 + ] 4714 + } 4715 + ] 4716 + } 4717 + ] 4718 +} 4719 + 4720 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4721 + 4722 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4723 + 4724 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4725 + 4726 +(% class="box infomessage" %) 4727 +((( 4728 +**POST /api/v3/fuelcards/transactions** 4729 +))) 4730 + 4731 +Метод запроса: POST 4732 + 4733 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4734 +\\В заголовках запроса: X-Auth: Токен авторизации 4735 + 4736 +Параметры в теле запроса (JSON): 4737 + 4738 +{ 4739 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4740 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4741 + "ids": [ 4742 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4743 + ], 4744 + "timezone": 0 ~/~/ Часовой пояс 4745 +} 4746 + 4747 + 4748 +Ответ: 4749 + { 4750 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4751 + "driver": "string", ~/~/ Водители, привязанные к ТК 4752 + "object": "string", ~/~/ Наименование ТС 4753 + "amount": 0, ~/~/ Количество топлива 4754 + "amountDut": 0, ~/~/ Количество по ДУТ 4755 + "amountDiff": 0, ~/~/ Разница, л 4756 + "amountDiffPerc": 0, ~/~/ Разница, % 4757 + "summa": 0, ~/~/ Стоимость, руб 4758 + "serviceName": "string", ~/~/ Тип топлива 4759 + "price": 0, ~/~/ Цена за литр, руб 4760 + "cardName": "string", ~/~/ Наименование ТК 4761 + "cardNum": "string", ~/~/ Номер ТК 4762 + "operator": "string", ~/~/ Оператор ТК 4763 + "address": "string" ~/~/ Адрес АЗС 4764 + } 4765 + 4766 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4767 + 4768 +(% class="box infomessage" %) 4769 +((( 4770 +**GET /api/v3/fuelcards** 4771 +))) 4772 + 4773 +Метод запроса: GET 4774 + 4775 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4776 + 4777 +Ответ: 4778 + 4779 +[ 4780 + { 4781 + "Name": "string", ~/~/ Определяет наименование карты. 4782 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4783 + "Number": "string", ~/~/ Определяет № карты. 4784 + "Enabled": true, ~/~/ Определяет признак активности карты. 4785 + "Description": "string", ~/~/ Определяет описание карты. 4786 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4787 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4788 + "deleted": true ~/~/ Признак удаления 4789 + } 4790 +] 4791 + 4792 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4793 + 4794 + 4795 +== **Получение полных данных о ретрансляторе** == 4796 + 4797 +(% class="box infomessage" %) 4798 +((( 4799 +**GET ** **/api/v3/retranslations/{id}** 4800 +))) 4801 + 4802 +id - Идентификатор ретранслятора 4803 + 4804 + 4805 +Пример ответа: 4806 + 4807 +{ 4808 +"description": "", ~/~/ Поле описания ретранслятора 4809 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4810 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4811 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4812 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4813 +"objects": [ ~/~/ Объекты для ретрансляции 4814 +{ 4815 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4816 +"name": "", ~/~/ Наименование объекта ретрансляции 4817 +"imei": "", ~/~/ IMEI объекта ретрансляции 4818 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4819 +} 4820 + ], 4821 +"id": "", ~/~/ Идентификатор ретранслятора 4822 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4823 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4824 +} 4825 + 4826 + 4827 +== **Удаление данных ретранслятора** == 4828 + 4829 +(% class="box infomessage" %) 4830 +((( 4831 +**DELETE** **/api/v3/retranslations/{id}** 4832 +))) 4833 + 4834 +id - Идентификатор ретранслятора 4835 + 4836 + 4837 +== **Создание ретранслятора** == 4838 + 4839 +(% class="box infomessage" %) 4840 +((( 4841 +**POST ** **/api/v3/retranslations/{id}** 4842 +))) 4843 + 4844 +Запрос: 4845 + 4846 +{ 4847 +"description": "", ~/~/ Поле описания ретранслятора 4848 +"subscriberId": "", ~/~/ Идентификатор подписчика 4849 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4850 +"address": "", ~/~/ Адрес и порт принимающего сервера 4851 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4852 +"objects": [ ~/~/Объекты для ретрансляции 4853 +{ 4854 +"id": "", ~/~/ Идентификатор ретранслятора 4855 +"imei": "", ~/~/ IMEI объекта ретрансляции 4856 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4857 +} 4858 + ] 4859 +} 4860 + 4861 + 4862 +Ответ: 4863 + 4864 +{ 4865 +"description": "", ~/~/ Поле описания ретранслятора 4866 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4867 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4868 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4869 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4870 +"objects": [ ~/~/ Объекты для ретрансляции 4871 +{ 4872 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4873 +"name": "string", ~/~/ Наименование объекта ретрансляции 4874 +"imei": "", ~/~/ IMEI объекта ретрансляции 4875 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4876 +} 4877 + ], 4878 +"id": "", ~/~/ Идентификатор ретранслятора 4879 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4880 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4881 +} 4882 + 4883 + 4884 +== **Редактирование ретранслятора** == 4885 + 4886 +(% class="box infomessage" %) 4887 +((( 4888 +**PUT** **/api/v3/retranslations** 4889 +))) 4890 + 4891 +Пример запроса: 4892 + 4893 +{ 4894 +"id": "", ~/~/ Идентификатор ретранслятора 4895 +"description": "string", ~/~/ Поле описания ретранслятора 4896 +"subscriberId": "", ~/~/ Идентификатор подписчика 4897 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4898 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4899 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4900 +"objects": ~/~/ Объекты для ретрансляции 4901 +[ 4902 +{ 4903 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4904 +"imei": "", ~/~/ IMEI объекта ретрансляции 4905 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4906 +} 4907 + ] 4908 +} 4909 + 4910 + 4911 +Пример ответа: 4912 + 4913 +{ 4914 +"description": "", ~/~/ Поле описания ретранслятора 4915 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4916 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4917 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4918 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4919 +"objects": [ ~/~/ Объекты для ретрансляции 4920 +{ 4921 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4922 +"name": "string", ~/~/ Наименование объекта ретрансляции 4923 +"imei": "", ~/~/ IMEI объекта ретрансляции 4924 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4925 +} 4926 + ], 4927 +"id": "", ~/~/ Идентификатор ретранслятора 4928 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4929 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4930 +} 4931 + 4932 + 4933 +== **Получение списка ретранслятора клиента** == 4934 + 4935 +(% class="box infomessage" %) 4936 +((( 4937 +**POST /api/v3/retranslations/find** 4938 +))) 4939 + 4940 +Пример запроса: 4941 + 4942 +{ 4943 +"id": "", ~/~/ Идентификатор ретранслятора 4944 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4945 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4946 +} 4947 + 4948 +Ответ: 4949 + 4950 +[ 4951 +{ 4952 +"description": "", ~/~/ Поле описания ретранслятора 4953 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4954 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4955 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4956 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4957 +"id": "", ~/~/ Идентификатор ретранслятора 4958 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4959 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4960 +} 4961 +] 4962 + 4963 + 4964 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4965 + 4966 +== **API для отчета по выгрузке комбайнов** == 4967 + 4968 +(% class="box infomessage" %) 4969 +((( 4970 +**POST /api/v3/Reports/harvesterUnloading** 4971 +))) 4972 + 4973 +Пример запроса: 4974 + 4975 +{ 4976 + "byTime": 0, ~/~/ Объединение событий по времени 4977 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4978 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4979 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4980 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4981 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4982 + 0 4983 + ], 4984 + "from": "", ~/~/ Дата и время начало запроса 4985 + "to": "", ~/~/ Дата и время окончания запроса 4986 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4987 +} 4988 + 4989 +Пример ответа: 4990 + 4991 +[ 4992 + { 4993 + "harvesterName": "", ~/~/Комбайн, номер 4994 + "harvesterId": 0, ~/~/Комбайн, id 4995 +"harvesterModel": "", ~/~/ Модель комбайна 4996 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4997 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4998 + "events": [ ~/~/Список событий в разрезе комбайна 4999 + { 5000 + "driverId": "", ~/~/Идентификатор водителя 5001 + "driverName": "", ~/~/Водитель комбайна, ФИО 5002 + "RFID": "", ~/~/ идентификатор карты-метки 5003 + "rfidName": "", ~/~/Водитель комбайна, имя метки 5004 + "vehicleId": 0, ~/~/идентификатор объекта 5005 + "vehicleName": "string", ~/~/ Имя объекта 5006 + "modelName": "string", ~/~/ Имя модели объекта 5007 + "nearestVehicles": [ ~/~/Объекты рядом 5008 + { 5009 + "vehicleId": 0, ~/~/идентификатор объекта 5010 + "vehicleName": "string" ~/~/ Имя объекта 5011 + } 5012 + ], 5013 + "fields": [ ~/~/Поля, где происходила выгрузка 5014 + { 5015 + "id": 0, ~/~/ идентификатор пользователя 5016 + "name": "string" ~/~/ имя пользователя 5017 + } 5018 + ], 5019 + "event": "string", ~/~/Событие 5020 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 5021 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 5022 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 5023 + "cultureName": "string", ~/~/ название культуры 5024 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 5025 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 5026 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 5027 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 5028 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 5029 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 5030 + "issued": 0, ~/~/Выдано, бункеров 5031 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 5032 + "latitude": 0, ~/~/Широта 5033 + "longitude": 0, ~/~/ Долгота 5034 + "litresAway": 0, ~/~/Отдано, л 5035 + "m3Away": 0 ~/~/Отдано, м3 5036 + } 5037 + ] 5038 + } 5039 +] 5040 + 5041 + 5042 +== **Отчет трек-датчики** == 5043 + 5044 +(% class="box infomessage" %) 5045 +((( 5046 +**POST /api/v3/Reports/sensorsWorks** 5047 +))) 5048 + 5049 +**Пример запроса:** 5050 + 5051 +{ 5052 + "vehicleIds": [ ~/~/ Список ID объектов 5053 + 0 5054 + ], 5055 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5056 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5057 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5058 +} 5059 + 5060 +**Пример ответа:** 5061 + 5062 +((( 5063 +{ 5064 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5065 + { 5066 + "vehicleId": 0, ~/~/ Идентификатор ТС 5067 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5068 + { 5069 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5070 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5071 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5072 + "name": "string", ~/~/ Наименование оборудования. 5073 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5074 + "totalMileage": 0, ~/~/ Общий пробег. 5075 + "avgSpeed": 0 ~/~/ Средняя скорость. 5076 + } 5077 + ] 5078 + } 5079 + ] 5080 +} 5081 + 5082 + 5083 +== **Превышение скорости** == 5084 + 5085 +(% class="box infomessage" %) 5086 +((( 5087 +**POST /api/v3/Reports/overSpeedDuration** 5088 +))) 5089 + 5090 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5091 + 5092 +Пример запроса: 5093 + 5094 +((( 5095 +{ 5096 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5097 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5098 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5099 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5100 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5101 +} 5102 +))) 5103 + 5104 +((( 5105 + 5106 +))) 5107 + 5108 +((( 5109 +Пример ответа: 5110 +))) 5111 + 5112 +((( 5113 +((( 5114 +[ 5115 + { 5116 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5117 + "duration": 0, ~/~/ Продолжительность события в секундах 5118 + "maxSpeed": 0, ~/~/ Максимальная скорость 5119 + "speedLimit": 0 ~/~/ Ограничение скорости 5120 + } 5121 +] 5122 +))) 5123 +))) 5124 +))) 5125 + 5126 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5127 + 5128 + 5129 +== **Запрос списка полей** == 5130 + 5131 +(% class="box successmessage" %) 5132 +((( 5133 +**POST /api/v3/agroLands/find** 5134 +))) 5135 + 5136 +Пример запроса: 5137 + 5138 +((( 5139 +((( 5140 +((( 5141 +{ 5142 + "year": 0, ~/~/ Фильтр по году 5143 + "name": "string", ~/~/ Фильтр по названию 5144 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5145 +} 5146 +))) 5147 +))) 5148 + 5149 + 5150 +))) 5151 + 5152 +Пример ответа: 5153 + 5154 +((( 5155 +[ 5156 + { 5157 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5158 + "year": 0, ~/~/ Год поля 5159 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5160 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5161 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5162 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5163 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5164 + "counts": { ~/~/ Счётчики с/х поля 5165 + "fieldOperations": 0, ~/~/ Количество операций на поле 5166 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5167 + "facts": 0 ~/~/ Счётчик факта 5168 + }, 5169 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5170 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5171 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5172 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5173 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5174 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5175 + "planComment": "string", ~/~/ Комментарий к полю 5176 + "productivity": 0, ~/~/ Урожайность. 5177 + "id": 0, ~/~/ Идентификатор объекта геозоны 5178 + "name": "string", ~/~/ Название объекта геозоны 5179 + "type": 0, ~/~/ Тип объекта геозоны 5180 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5181 + "fname": "string", ~/~/ Имя файла 5182 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5183 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5184 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5185 + "description": "string", ~/~/ Описание объекта геозоны 5186 + "area": 0, ~/~/ Площадь, м2 5187 + "perimetr": 0, ~/~/ Периметр, м 5188 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5189 + } 5190 +] 5191 + 5192 + 5193 +== **Создание нового поля ** == 5194 + 5195 +(% class="box successmessage" %) 5196 +((( 5197 +**POST /api/v3/agroLands** 5198 +))) 5199 + 5200 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5201 +X-agent - ID клиента 5202 + 5203 +Пример запроса: 5204 + 5205 +((( 5206 +{ 5207 + "extId": "string", 5208 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5209 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5210 + "display": "string", ~/~/ Настройки отображения 5211 + "year": 0, ~/~/ Год поля 5212 + "name": "string", ~/~/ Наименование 5213 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5214 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5215 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5216 + "planComment": "string", ~/~/ Комментарий к полю 5217 + "cropRotations": [ ~/~/ Данные по севообороту 5218 + { 5219 + "landId": 0, ~/~/ ID поля 5220 + "landName": "string", ~/~/ Название поля 5221 + "year": 0, ~/~/ Год урожая 5222 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5223 + "cultureName": "string", ~/~/ Название культуры 5224 + "productivity": 0, ~/~/ Урожайность 5225 + "area": 0, ~/~/ Площадь поля, Га 5226 + "total": 0, ~/~/ Валовый сбор 5227 + "productivityFact": 0, ~/~/ Фактическая урожайность 5228 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5229 + "totalFact": 0, ~/~/ Фактический валовый сбор 5230 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5231 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5232 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5233 + "isyearplan": true, ~/~/ Годовой план 5234 + "comment": "string" ~/~/ Комментарий 5235 + } 5236 + ] 5237 +} 5238 +))) 5239 + 5240 +((( 5241 + 5242 +))) 5243 + 5244 +Пример ответа: 5245 + 5246 +((( 5247 +((( 5248 +{ 5249 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5250 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5251 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5252 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5253 + "cropRotations": [ ~/~/ Данные по севообороту 5254 + { 5255 + "landId": 0, ~/~/ ID поля 5256 + "landName": "string", ~/~/ Название поля 5257 + "year": 0, ~/~/ Год урожая 5258 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5259 + "cultureName": "string", ~/~/ Название культуры 5260 + "productivity": 0, ~/~/ Урожайность 5261 + "area": 0, ~/~/ Площадь поля, Га. 5262 + "total": 0, ~/~/ Валовый сбор 5263 + "productivityFact": 0, ~/~/ Фактическая урожайность 5264 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5265 + "totalFact": 0, ~/~/ Фактический валовый сбор 5266 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5267 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5268 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5269 + "isyearplan": true, ~/~/ годовой план 5270 + "comment": "string" ~/~/ Комментарий 5271 + } 5272 + ], 5273 + "cropVegetation": [ ~/~/ История вегетации поля 5274 + { 5275 + "values": [ ~/~/ Данные вегетации и состояния посева 5276 + { 5277 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5278 + "ndvi": 0 ~/~/ Индекс вегетации 5279 + } 5280 + ], 5281 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5282 + { 5283 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5284 + "type": "string", ~/~/ Тип 5285 + "pictureid": "string" ~/~/ Идентификатор ресурса 5286 + } 5287 + ], 5288 + "states": [ ~/~/ Ключевые даты развития поля 5289 + { 5290 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5291 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5292 + } 5293 + ] 5294 + } 5295 + ], 5296 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5297 + "counts": { 5298 + "fieldOperations": 0, ~/~/ Количество операций на поле 5299 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5300 + "facts": 0 ~/~/ Счётчик факта 5301 + }, 5302 + "planComment": "string", ~/~/ Комментарий к полю 5303 +))) 5304 + 5305 +((( 5306 + "productivity": 0, ~/~/ Урожайность. 5307 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5308 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5309 + "year": 0, ~/~/ Год поля 5310 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5311 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5312 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5313 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5314 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5315 + "id": 0, ~/~/ Идентификатор объекта геозоны 5316 + "name": "string", ~/~/ Название объекта геозоны 5317 + "type": 0, ~/~/ Тип объекта геозоны 5318 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5319 + "fname": "string", ~/~/ Имя файла 5320 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5321 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5322 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5323 + "description": "string", ~/~/ Описание объекта геозоны 5324 + "area": 0, ~/~/ Площадь, м2 5325 + "perimetr": 0, ~/~/ Периметр, м 5326 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5327 +} 5328 + 5329 + 5330 +))) 5331 +))) 5332 +))) 5333 + 5334 +== **Получение поля по id** == 5335 + 5336 +(% class="box infomessage" %) 5337 +((( 5338 +**GET /api/v3/agroLands/{id}** 5339 +))) 5340 + 5341 +Пример запроса: 5342 +id ~/~/ Идентификатор поля 5343 + 5344 +Пример ответа: 5345 + 5346 +((( 5347 +{ 5348 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5349 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5350 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5351 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5352 + "cropRotations": [ ~/~/ Данные по севообороту 5353 + { 5354 + "landId": 0, ~/~/ ID поля 5355 + "landName": "string", ~/~/ Название поля 5356 + "year": 0, ~/~/ Год урожая 5357 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5358 + "cultureName": "string", ~/~/ Название культуры 5359 + "productivity": 0, ~/~/ Урожайность 5360 + "area": 0, ~/~/ Площадь поля, Га 5361 + "total": 0, ~/~/ Валовый сбор 5362 + "productivityFact": 0, ~/~/ Фактическая урожайность 5363 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5364 + "totalFact": 0, ~/~/ Фактический валовый сбор 5365 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5366 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5367 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5368 + "isyearplan": true, ~/~/ План года 5369 + "comment": "string" ~/~/ Комментарий 5370 + } 5371 + ], 5372 + "cropVegetation": [ ~/~/ История вегетации поля 5373 + { 5374 + "values": [ ~/~/ Данные вегетации и состояния посева 5375 + { 5376 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5377 + "ndvi": 0 ~/~/ Индекс вегетации 5378 + } 5379 + ], 5380 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5381 + { 5382 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5383 + "type": "string", ~/~/ Тип 5384 + "pictureid": "string" ~/~/ Идентификатор ресурса 5385 + } 5386 + ], 5387 + "states": [ ~/~/ Ключевые даты развития поля 5388 + { 5389 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5390 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5391 + } 5392 + ] 5393 + } 5394 + ], 5395 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5396 + "counts": { 5397 + "fieldOperations": 0, ~/~/ Количество операций на поле 5398 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5399 + "facts": 0 ~/~/ Счётчик факта 5400 + }, 5401 + "planComment": "string", ~/~/ Комментарий к полю 5402 + "productivity": 0, ~/~/ Урожайность. 5403 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5404 +))) 5405 + 5406 +((( 5407 +((( 5408 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5409 + "year": 0, ~/~/ Год поля 5410 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5411 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5412 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5413 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5414 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5415 + "id": 0, ~/~/ Идентификатор объекта геозоны 5416 + "name": "string", ~/~/ Название объекта геозоны 5417 + "type": 0, ~/~/ Тип объекта геозоны 5418 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5419 + "fname": "string", ~/~/ Имя файла 5420 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5421 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5422 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5423 + "description": "string", ~/~/ Описание объекта геозоны 5424 + "area": 0, ~/~/ Площадь, м2 5425 + "perimetr": 0, ~/~/ Периметр, м 5426 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5427 +} 5428 +))) 5429 + 5430 + 5431 + 5432 +((( 5433 + 5434 +))) 5435 + 5436 +((( 5437 +((( 5438 +((( 5439 +== **Изменение поля** == 5440 + 5441 +(% class="box infomessage" %) 5442 +((( 5443 +**PUT /api/v3/agroLands** 5444 +))) 5445 + 5446 +Пример запроса: 5447 + 5448 +((( 5449 +((( 5450 +{ 5451 + "id": 0, ~/~/ Идентификатор поля 5452 + "extId": "string", ~/~/ ExtId 5453 + "shape": "string", ~/~/ Форма поля 5454 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5455 + "display": "string", ~/~/ Настройки отображения 5456 + "year": 0, ~/~/ Год поля 5457 + "name": "string", ~/~/ Наименование 5458 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5459 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5460 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5461 + "planComment": "string", ~/~/Комментарий к полю 5462 + "cropRotations": [ ~/~/ Данные по севообороту 5463 + { 5464 + "landId": 0, ~/~/ ID поля 5465 + "landName": "string", ~/~/ Название поля 5466 + "year": 0, ~/~/ Год урожая 5467 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5468 + "cultureName": "string", ~/~/ Название культуры 5469 + "productivity": 0, ~/~/ Урожайность 5470 + "area": 0, ~/~/ Площадь поля, Га. 5471 + "total": 0, ~/~/ Валовый сбор 5472 + "productivityFact": 0, ~/~/ Фактическая урожайность 5473 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5474 + "totalFact": 0, ~/~/ Фактический валовый сбор 5475 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5476 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5477 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5478 + "isyearplan": true, 5479 + "comment": "string" ~/~/ Комментарий 5480 + } 5481 + ], 5482 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5483 +} 5484 +))) 5485 +))) 5486 + 5487 +((( 5488 + 5489 +))) 5490 + 5491 +Пример ответа: 5492 + 5493 +((( 5494 +((( 5495 +((( 5496 +{ 5497 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5498 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5499 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5500 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5501 + "cropRotations": [ ~/~/ Данные по севообороту 5502 + { 5503 + "landId": 0, ~/~/ ID поля 5504 + "landName": "string", ~/~/ Название поля 5505 + "year": 0, ~/~/ Год урожая 5506 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5507 + "cultureName": "string", ~/~/ Название культуры 5508 + "productivity": 0, ~/~/ Урожайность 5509 + "area": 0, ~/~/ Площадь поля, Га 5510 + "total": 0, ~/~/ Валовый сбор 5511 + "productivityFact": 0, ~/~/ Фактическая урожайность 5512 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5513 + "totalFact": 0, ~/~/ Фактический валовый сбор 5514 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5515 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5516 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5517 + "isyearplan": true, ~/~/ 5518 + "comment": "string" ~/~/ Комментарий 5519 + } 5520 + ], 5521 + "cropVegetation": [ ~/~/ История вегетации поля 5522 + { 5523 + "values": [ ~/~/ Данные вегетации и состояния посева 5524 + { 5525 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5526 + "ndvi": 0 ~/~/ Индекс вегетации 5527 + } 5528 + ], 5529 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5530 + { 5531 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5532 + "type": "string", ~/~/ Тип 5533 + "pictureid": "string" ~/~/ Идентификатор ресурса 5534 + } 5535 + ], 5536 + "states": [ ~/~/ Ключевые даты развития поля 5537 + { 5538 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5539 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5540 + } 5541 + ] 5542 + } 5543 + ], 5544 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5545 + "counts": { 5546 + "fieldOperations": 0, ~/~/ Количество операций на поле 5547 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5548 + "facts": 0 ~/~/ Счётчик факта 5549 + }, 5550 + "planComment": "string", ~/~/ Комментарий к полю 5551 + "productivity": 0, ~/~/ Урожайность. 5552 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5553 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5554 + "year": 0, ~/~/ Год поля 5555 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5556 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5557 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5558 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5559 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5560 + "id": 0, ~/~/ Идентификатор объекта геозоны 5561 + "name": "string", ~/~/ Название объекта геозоны 5562 + "type": 0, ~/~/ Тип объекта геозоны 5563 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5564 + "fname": "string", ~/~/ Имя файла 5565 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5566 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5567 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5568 + "description": "string", ~/~/ Описание объекта геозоны 5569 + "area": 0, ~/~/ Площадь, м2 5570 + "perimetr": 0, ~/~/ Периметр, м 5571 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5572 +} 5573 +))) 5574 +))) 5575 +))) 5576 +))) 5577 +))) 5578 + 5579 + 5580 +== **Редактирование года урожая ** == 5581 + 5582 +(% class="box successmessage" %) 5583 +((( 5584 +**POST /api/v3/agroLands/updateOpenCloseYear** 5585 +))) 5586 + 5587 +Пример запроса: 5588 + 5589 +((( 5590 +((( 5591 +{ 5592 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5593 + 0 5594 + ], 5595 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5596 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5597 +} 5598 +))) 5599 + 5600 + 5601 +))) 5602 + 5603 +Пример ответа: 5604 + 5605 +((( 5606 +((( 5607 +{ 5608 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5609 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5610 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5611 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5612 + "cropRotations": [ ~/~/ Данные по севообороту 5613 + { 5614 + "landId": 0, ~/~/ ID поля 5615 + "landName": "string", ~/~/ Название поля 5616 + "year": 0, ~/~/ Год урожая 5617 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5618 + "cultureName": "string", ~/~/ Название культуры 5619 + "productivity": 0, ~/~/ Урожайность 5620 + "area": 0, ~/~/ Площадь поля, Га. 5621 + "total": 0, ~/~/ Валовый сбор 5622 + "productivityFact": 0, ~/~/ Фактическая урожайность 5623 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5624 + "totalFact": 0, ~/~/ Фактический валовый сбор 5625 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5626 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5627 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5628 + "isyearplan": true, ~/~/ 5629 + "comment": "string" ~/~/ Комментарий 5630 + } 5631 + ], 5632 + "cropVegetation": [ ~/~/ История вегетации поля 5633 + { 5634 + "values": [ ~/~/ Данные вегетации и состояния посева 5635 + { 5636 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5637 + "ndvi": 0 ~/~/ Индекс вегетации 5638 + } 5639 + ], 5640 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5641 + { 5642 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5643 + "type": "string", ~/~/ Тип 5644 + "pictureid": "string" ~/~/ Идентификатор ресурса 5645 + } 5646 + ], 5647 + "states": [ ~/~/ Ключевые даты развития поля 5648 + { 5649 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5650 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5651 + } 5652 + ] 5653 + } 5654 + ], 5655 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5656 + "counts": { 5657 + "fieldOperations": 0, ~/~/ Количество операций на поле 5658 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5659 + "facts": 0 ~/~/ Счётчик факта 5660 + }, 5661 + "planComment": "string", ~/~/ Комментарий к полю 5662 + "productivity": 0, ~/~/ Урожайность. 5663 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5664 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5665 + "year": 0, ~/~/ Год поля 5666 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5667 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5668 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5669 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5670 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5671 + "id": 0, ~/~/ Идентификатор объекта геозоны 5672 + "name": "string", ~/~/ Название объекта геозоны 5673 + "type": 0, ~/~/ Тип объекта геозоны 5674 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5675 + "fname": "string", ~/~/ Имя файла 5676 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5677 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5678 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5679 + "description": "string", ~/~/ Описание объекта геозоны 5680 + "area": 0, ~/~/ Площадь, м2 5681 + "perimetr": 0, ~/~/ ериметр, м 5682 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5683 +} 5684 + 5685 + 5686 +== **Какие поля посещал объект** == 5687 + 5688 +(% class="box successmessage" %) 5689 +((( 5690 +**POST /api/v3/agroLands/visitingByVehicle** 5691 +))) 5692 + 5693 +Пример запроса: 5694 + 5695 +{ 5696 + "vehicleId": 0, ~/~/ id объекта 5697 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5698 + "byTime": 0, ~/~/ Объединение событий по времени 5699 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5700 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5701 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5702 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5703 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5704 +} 5705 + 5706 +Пример ответа: 5707 + 5708 +[ 5709 + { 5710 + "fieldId": 0, ~/~/ id объекта 5711 + "vehicleName": "string", ~/~/ Наименование объекта 5712 + "fieldName": "string", ~/~/ Наименование поля 5713 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5714 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5715 + "vehicleId": 0, ~/~/ Идентификатор ТС 5716 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5717 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5718 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5719 + "mileage": 0 ~/~/ Пробег 5720 + } 5721 +] 5722 +))) 5723 + 5724 + 5725 +== **Посещение поля объектами ** == 5726 + 5727 +(% class="box successmessage" %) 5728 +((( 5729 +**POST /api/v3/agroLands/visitingByField** 5730 +))) 5731 + 5732 +Пример запроса: 5733 +{ 5734 + "fieldId": 0, ~/~/ ID поля 5735 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5736 + "byTime": 0, ~/~/ Объединение событий по времени 5737 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5738 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5739 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5740 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5741 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5742 +} 5743 + 5744 +Пример ответа: 5745 + 5746 +[ 5747 + { 5748 + "fieldId": 0, ~/~/ ID поля 5749 + "vehicleName": "string", ~/~/ Наименование объекта 5750 + "fieldName": "string", ~/~/ Имя поля 5751 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5752 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5753 + "vehicleId": 0, ~/~/ Идентификатор ТС 5754 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5755 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5756 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5757 + "mileage": 0 ~/~/ Пробег 5758 + } 5759 +] 5760 + 5761 + 5762 +== **Удаление существующего поля** == 5763 + 5764 +(% class="box errormessage" %) 5765 +((( 5766 +**DELETE /api/v3/agroLands/{id}** 5767 +))) 5768 + 5769 +Пример запроса: 5770 +id ~/~/ Идентификатор поля 5771 + 5772 +Пример ответа: 5773 + 5774 +((( 5775 +200 ~/~/ Успех 5776 + 5777 + 5778 +))) 5779 + 5780 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5781 +))) 5782 +))) 5783 +))) 5784 + 5785 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5786 + 5787 + 5788 +(% class="box infomessage" %) 5789 +((( 5790 +**GET api/v3/Vehicles/recyclebin/all** 5791 +))) 5792 + 5793 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5794 + 5795 +Параметр запроса: {parentId} - идентификатор агента 5796 + 5797 +В заголовках запроса: X-Auth: Токен авторизации 5798 + 5799 +Ответ: 5800 + 5801 +[ 5802 + { 5803 + "recordTime": "", ~/~/Время записи 5804 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5805 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5806 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5807 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5808 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5809 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5810 + "items": [ ~/~/ 5811 +nullable: true ~/~/Детали 5812 + { 5813 + "name": "string", ~/~/наименование столбца 5814 + "value": "string" ~/~/содержание столбца 5815 + } 5816 + ] 5817 + }, 5818 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5819 + "string" 5820 + ] 5821 + } 5822 +] 5823 + 5824 + 5825 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5826 + 5827 +(% class="box infomessage" %) 5828 +((( 5829 +**POST api/v3/Vehicles/recyclebin/erase** 5830 +))) 5831 + 5832 +В заголовках запроса: X-Auth: Токен авторизации 5833 + 5834 +Пример запроса: 5835 + 5836 +[ 5837 +0 5838 +] 5839 + 5840 + 5841 +Пример ответа: 5842 + 5843 +[ 5844 +{ 5845 + "recordTime": "", ~/~/Время записи 5846 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5847 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5848 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5849 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5850 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5851 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5852 + "items": [ ~/~/Детали 5853 + { 5854 + "name": "", ~/~/Имя свойства 5855 + "value": "" ~/~/Значение свойства 5856 + } 5857 + ] 5858 + }, 5859 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5860 + "" 5861 + ] 5862 + } 5863 +] 5864 + 5865 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5866 + 5867 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5868 + 5869 +(% class="box infomessage" %) 5870 +((( 5871 +**POST api/v3/Vehicles/recyclebin/restore** 5872 +))) 5873 + 5874 +В заголовках запроса: X-Auth: Токен авторизации 5875 + 5876 +Параметры в теле запроса (JSON): 5877 + 5878 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5879 + 5880 +В заголовках запроса: X-Auth: Токен авторизации 5881 + 5882 + 5883 +Пример запроса: 5884 + 5885 +((( 5886 +[ 5887 +))) 5888 + 5889 +((( 5890 + 0 5891 +))) 5892 + 5893 +((( 5894 +] 5895 +))) 5896 + 5897 + 5898 +Пример ответа: 5899 + 5900 +[ 5901 +{ 5902 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5903 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5904 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5905 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5906 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5907 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5908 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5909 + "items": [ ~/~/Детали 5910 + { 5911 + "name": "string", ~/~/Имя свойства 5912 + "value": "string" ~/~/Значение свойства 5913 + } 5914 + ] 5915 + }, 5916 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5917 + "string" 5918 + ] 5919 + } 5920 +] 5921 + 5922 + 5923 += **Раздел: Журнал заданий ** = 5924 + 5925 + 5926 +== **Создание задания в Журнале заданий** == 5927 + 5928 +(% class="box infomessage" %) 5929 +((( 5930 +**POST /api/v3/vehicletasks** 5931 +))) 5932 + 5933 +Пример запроса: 5934 + 5935 +((( 5936 +{ 5937 + "vehicleId": 0, ~/~/ Идентификатор ТС 5938 + "description": "string", ~/~/ Описание 5939 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5940 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5941 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5942 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5943 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5944 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5945 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5946 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5947 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5948 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5949 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5950 + "cost": { 5951 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5952 + "Name": "string", ~/~/ Наименование 5953 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5954 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5955 + "Norm": 0 ~/~/ Норма внесения 5956 + }, 5957 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5958 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5959 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5960 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5961 + "deleted": true, ~/~/ Признак удаления 5962 + "extId": "string", 5963 + "GeoIds": [ ~/~/ Cвязанные поля 5964 + 0 5965 + ] 5966 +} 5967 +))) 5968 + 5969 + 5970 +Пример ответа: 5971 + 5972 +{ 5973 + "vehicleId": 0, ~/~/ Идентификатор ТС 5974 + "description": "string", ~/~/ Описание 5975 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5976 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5977 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5978 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5979 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5980 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5981 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5982 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5983 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5984 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5985 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5986 + "cost": { 5987 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5988 + "Name": "string", ~/~/ Наименование 5989 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5990 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5991 + "Norm": 0 ~/~/ Норма внесения 5992 + }, 5993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5994 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5995 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5996 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5997 + "deleted": true, ~/~/ Признак удаления 5998 + "extId": "string", ~/~/ ExtId 5999 + "GeoIds": [ ~/~/ Связанные поля 6000 + 0 6001 + ] 6002 +} 6003 + 6004 + 6005 +== **Редактирование задания в Журнале заданий** == 6006 + 6007 +(% class="box successmessage" %) 6008 +((( 6009 +**PUT /api/v3/vehicletasks** 6010 +))) 6011 + 6012 +Пример запроса: 6013 + 6014 +((( 6015 +{ 6016 + "vehicleId": 0, ~/~/ Идентификатор ТС 6017 + "description": "string", ~/~/ Описание 6018 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6019 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6020 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 6021 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 6022 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6023 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6024 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6025 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6026 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6027 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6028 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6029 + "cost": { 6030 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6031 + "Name": "string", ~/~/ Наименование 6032 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6033 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6034 + "Norm": 0 ~/~/ Норма внесения 6035 + }, 6036 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6037 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6038 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 6039 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 6040 + "deleted": true, ~/~/ Признак удаления 6041 + "extId": "string", ~/~/ ExtId 6042 + "GeoIds": [ ~/~/ Связанные поля 6043 + 0 6044 + ] 6045 +} 6046 +))) 6047 + 6048 + 6049 +Пример ответа: 6050 + 6051 +{ 6052 + "vehicleId": 0, ~/~/ Идентификатор ТС 6053 + "description": "string", ~/~/ Описание 6054 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6055 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6056 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6057 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6058 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6059 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6060 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6061 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6062 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6063 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6064 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6065 + "cost": { 6066 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6067 + "Name": "string", ~/~/ Наименование 6068 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6069 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6070 + "Norm": 0 ~/~/ Норма внесения 6071 + }, 6072 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6073 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6074 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6075 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6076 + "deleted": true, ~/~/ Признак удаления 6077 + "extId": "string", ~/~/ ExtId 6078 + "GeoIds": [ ~/~/ Связанные поля 6079 + 0 6080 + ] 6081 +} 6082 + 6083 + 6084 +== **Удаление задания в Журнале заданий** == 6085 + 6086 +(% class="box warningmessage" %) 6087 +((( 6088 +**DELETE /api/v3/vehicletasks** 6089 +))) 6090 + 6091 +Пример запроса: 6092 + 6093 +((( 6094 +[ 6095 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6096 +] 6097 +))) 6098 + 6099 +((( 6100 + 6101 +))) 6102 + 6103 +Пример ответа: 6104 + 6105 +{ 6106 + "vehicleId": 0, ~/~/ Идентификатор ТС 6107 + "description": "string", ~/~/ Описание 6108 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6109 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6110 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6111 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6112 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6113 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6114 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6115 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6116 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6117 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6118 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6119 + "cost": { 6120 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6121 + "Name": "string", ~/~/ Наименование 6122 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6123 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6124 + "Norm": 0 ~/~/ Норма внесения 6125 + }, 6126 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6127 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6128 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6129 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6130 + "deleted": true, ~/~/ Признак удаления 6131 + "extId": "string", ~/~/ ExtId 6132 + "GeoIds": [ ~/~/ Связанные поля 6133 + 0 6134 + ] 6135 +} 6136 + 6137 + 6138 +== **Получение списка Журнала заданий** == 6139 + 6140 +(% class="box infomessage" %) 6141 +((( 6142 +**POST /api/v3/vehicletasks/getbyperiod** 6143 +))) 6144 + 6145 +Пример запроса: 6146 + 6147 +((( 6148 +{ 6149 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6150 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6151 + "TimeZone": 0, ~/~/ Часовой пояс. 6152 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6153 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6154 + ], 6155 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6156 + 0 6157 + ], 6158 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6159 + 0 6160 + ], 6161 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6162 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6163 +} 6164 +))) 6165 + 6166 + 6167 +Пример ответа: 6168 + 6169 +((( 6170 +{ 6171 + "total": 0, ~/~/ Общее количество записей 6172 + "pages": 0, ~/~/ Общее количество страниц 6173 + "currentPage": 0, ~/~/ Текущая страница 6174 + "items": [ ~/~/ Записи 6175 + { 6176 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6177 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6178 + "name": "string", ~/~/ Название задания. 6179 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6180 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6181 + "workKind": "string", ~/~/ Вид работ 6182 + "techOp": "string", ~/~/ Тех. операция 6183 + "trailerModel": "string", ~/~/ Модель агрегата 6184 + "width": "string", ~/~/ Ширина, м 6185 + "speed": "string", ~/~/ Тех. скорость 6186 + "fields": "string", ~/~/ Поля 6187 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6188 + "vehicles": "string", ~/~/ Объект-модель 6189 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6190 + "drivers": "string", ~/~/ Водители 6191 + "tmc": "string", ~/~/ ТМЦ 6192 + "client": "string", ~/~/ Клиент 6193 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6194 + "dep": "string", ~/~/ Подразделение 6195 + "geoIds": [ ~/~/ Связанные поля 6196 + 0 6197 + ] 6198 + } 6199 + ] 6200 +} 6201 +))) 6202 + 6203 + 6204 += **Раздел: Роли** = 6205 + 6206 +== **Получение списка клиентских и системных ролей пользователя ** == 6207 + 6208 +(% class="box successmessage" %) 6209 +((( 6210 +**POST /api/v3/groups/find** 6211 +))) 6212 + 6213 +Пример запроса: 6214 + 6215 +((( 6216 +{ 6217 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6218 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6219 +} 6220 +))) 6221 + 6222 +((( 6223 + 6224 +))) 6225 + 6226 +((( 6227 +Пример ответа: 6228 +))) 6229 + 6230 +((( 6231 +((( 6232 +{ 6233 + "groups": [ ~/~/ Системные роли пользователя 6234 + { 6235 + "code": "string", ~/~/ Код роли. 6236 + "name": "string", ~/~/ Имя 6237 + "shortName": "string" ~/~/ Короткое имя 6238 + } 6239 + ], 6240 + "customGroups": [ ~/~/ Системные роли пользователя 6241 + { 6242 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6243 + "name": "string", ~/~/ Наименование 6244 + "shortName": "string", ~/~/ Короткое наименование 6245 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6246 + } 6247 + ] 6248 +} 6249 +))) 6250 +))) 6251 + 6252 +((( 6253 + 6254 +))) 6255 + 6256 +((( 6257 + 6258 +))) 6259 + 6260 += **Раздел: Локатор ** = 6261 + 6262 + 6263 +== **Получение данных по локатору** == 6264 + 6265 +(% class="box infomessage" %) 6266 +((( 6267 +**GET /api/v3/locators/{locatorId}** 6268 +))) 6269 + 6270 +В запросе указывается locatorid - идентификатор локатора 6271 + 6272 + 6273 +Пример ответа: 6274 + 6275 +((( 6276 +((( 6277 +{ 6278 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6279 + 0 6280 + ], 6281 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6282 + 0 6283 + ], 6284 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6285 + 0 6286 + ], 6287 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6288 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6289 + "agentName": "string", ~/~/ Наименование агента. 6290 + "isEnabled": true, ~/~/ Активность 6291 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6292 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6293 + "name": "string", ~/~/ Наименование. 6294 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6295 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6296 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6297 + "validity": 0, ~/~/ Значение срока действия 6298 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6299 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6300 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6301 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6302 + "url": "string", ~/~/ Ссылка 6303 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6304 + 6305 + "showVehicleName": true, ~/~/ Наименование объекта 6306 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6307 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6308 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6309 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6310 + "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ГИС) 6311 + 6312 + 1 6313 + 6314 + ] 6315 +} 6316 +))) 6317 +))) 6318 + 6319 + 6320 +((( 6321 +((( 6322 + 6323 +))) 6324 +))) 6325 + 6326 + 6327 +== **Создание локатора** == 6328 + 6329 +(% class="box successmessage" %) 6330 +((( 6331 +**POST /api/v3/locators** 6332 +))) 6333 + 6334 +Пример запроса: 6335 + 6336 +((( 6337 +{ 6338 + "isEnabled": true, ~/~/ Активность 6339 + "name": "string", ~/~/ Наименование локатора 6340 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6341 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6342 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6343 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6344 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6345 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6346 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6347 + 0 6348 + ], 6349 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6350 + 0 6351 + ], 6352 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6353 + 0 6354 + ], 6355 + 6356 + "showVehicleName": true, ~/~/ Наименование объекта 6357 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6358 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6359 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6360 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6361 + "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ГИС) 6362 + 6363 + 1 6364 + 6365 + ] 6366 +} 6367 +))) 6368 + 6369 + 6370 +Пример ответа: 6371 + 6372 +((( 6373 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6374 +))) 6375 + 6376 + 6377 +== **Выводит список локаторов ** == 6378 + 6379 +(% class="box successmessage" %) 6380 +((( 6381 +**POST /api/v3/locators/find** 6382 +))) 6383 + 6384 +Пример запроса: 6385 + 6386 +((( 6387 +{ 6388 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6389 +} 6390 +))) 6391 + 6392 +((( 6393 + 6394 +))) 6395 + 6396 +((( 6397 + 6398 +))) 6399 + 6400 + 6401 +Пример ответа: 6402 + 6403 +((( 6404 +[ 6405 + { 6406 + "vehiclesCount": 0, ~/~/ Количество объектов. 6407 + "geozonesCount": 0, ~/~/ Количество геозон. 6408 + "fieldsCount": 0, ~/~/ Количество полей. 6409 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6410 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6411 + "agentName": "string", ~/~/ Наименование агента. 6412 + "isEnabled": true, ~/~/ Активность локатора 6413 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6414 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6415 + "name": "string", ~/~/ Наименование локатора 6416 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6417 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6418 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6419 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6420 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6421 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6422 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6423 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6424 + "url": "string", ~/~/ ссылка на локатор 6425 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6426 + "showVehicleName": true, ~/~/ Наименование объекта 6427 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6428 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6429 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6430 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6431 + "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ГИС) 6432 + 6433 + 0 6434 + ] 6435 + } 6436 +] 6437 +))) 6438 + 6439 + 6440 +== **Изменение локатора** == 6441 + 6442 +(% class="box infomessage" %) 6443 +((( 6444 +**PUT /api/v3/locators** 6445 +))) 6446 + 6447 +Пример запроса: 6448 + 6449 +((( 6450 +{ 6451 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6452 + "isEnabled": true, ~/~/ Активность 6453 + "name": "string", ~/~/ Наименование 6454 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6455 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6456 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6457 + "autoProlongation": true, ~/~/ Автопродление срока действия 6458 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6459 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6460 + 0 6461 + ], 6462 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6463 + 0 6464 + ], 6465 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6466 + 0 6467 + ], 6468 + "showVehicleName": true, ~/~/ Наименование объекта 6469 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6470 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6471 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6472 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6473 + "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ГИС) 6474 + 6475 + 0 6476 + 6477 + ] 6478 +} 6479 + 6480 + 6481 +))) 6482 + 6483 +Пример ответа: 6484 + 6485 +200 ~/~/ Success 6486 + 6487 + 6488 +== **Удалить локатор** == 6489 + 6490 +(% class="box warningmessage" %) 6491 +((( 6492 +**DELETE /api/v3/locators** 6493 +))) 6494 + 6495 +Пример запроса: 6496 + 6497 +((( 6498 +[ 6499 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6500 +] 6501 +))) 6502 + 6503 + 6504 += **Раздел: Яндекс Маршруты** = 6505 + 6506 + 6507 +== **Возвращение списка маршрутов** == 6508 + 6509 +(% class="box infomessage" %) 6510 +((( 6511 +**GET /api/v3/TransportRoutes** 6512 +))) 6513 + 6514 +Пример запроса: 6515 +Id ~/~/ Идентификатор поля 6516 + 6517 +Пример ответа: 6518 + 6519 +((( 6520 +[ 6521 + { 6522 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6523 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6524 + "name": "string", ~/~/ Наименование маршрута. 6525 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6526 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6527 + 0 6528 + ] 6529 + } 6530 +] 6531 +))) 6532 + 6533 + 6534 +== **Добавить маршрут** == 6535 + 6536 +(% class="box infomessage" %) 6537 +((( 6538 +**POST /api/v3/TransportRoutes** 6539 +))) 6540 + 6541 +Пример запроса: 6542 +{ 6543 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6544 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6545 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6546 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6547 + 0 6548 + ] 6549 +} 6550 + 6551 + 6552 +Пример ответа: 6553 + 6554 +((( 6555 +{ 6556 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6557 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6558 + "name": "string", ~/~/ Определяет наименование маршрута 6559 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6560 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6561 + 0 6562 + ] 6563 +} 6564 +))) 6565 + 6566 + 6567 +== **Обновление маршрута** == 6568 + 6569 +(% class="box successmessage" %) 6570 +((( 6571 +**PUT /api/v3/TransportRoutes** 6572 +))) 6573 + 6574 +Пример запроса: 6575 + 6576 +((( 6577 +{ 6578 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6579 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6580 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6581 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6582 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6583 + 0 6584 + ] 6585 +} 6586 +))) 6587 + 6588 +Пример ответа: 6589 + 6590 +((( 6591 +{ 6592 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6593 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6594 + "name": "string", ~/~/ Определяет наименование маршрута 6595 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6596 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6597 + 0 6598 + ] 6599 +} 6600 +))) 6601 + 6602 + 6603 +== **Получить связки маршрутов ТС** == 6604 + 6605 +(% class="box infomessage" %) 6606 +((( 6607 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6608 +))) 6609 + 6610 +Пример запроса: 6611 + 6612 +((( 6613 +[ 6614 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6615 +] 6616 +))) 6617 + 6618 +Пример ответа: 6619 + 6620 +((( 6621 +[ 6622 + { 6623 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6624 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6625 + } 6626 +] 6627 +))) 6628 + 6629 + 6630 +== **Удалить маршрут** == 6631 + 6632 +(% class="box warningmessage" %) 6633 +((( 6634 +**DELETE /api/v3/TransportRoutes/{id}** 6635 +))) 6636 + 6637 +Пример запроса: 6638 +Id ~/~/ Идентификатор поля 6639 + 6640 + 6641 += **Раздел: Управление доступа к машинам** = 6642 + 6643 + 6644 +== Получение списка транспортных средств видимых пользователю == 6645 + 6646 +(% class="box infomessage" %) 6647 +((( 6648 +**GET /api/v3/UserVisibleVehicles/{userId}** 6649 +))) 6650 + 6651 +Пример ответа: 6652 + 6653 +((( 6654 +{ 6655 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6656 + 0 6657 + ] 6658 +} 6659 +))) 6660 + 6661 + 6662 +== Задает видимость транспортных средств пользователю == 6663 + 6664 +(% class="box infomessage" %) 6665 +((( 6666 +**POST /api/v3/UserVisibleVehicles** 6667 +))) 6668 + 6669 +Пример запроса: 6670 + 6671 +((( 6672 +((( 6673 +{ 6674 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6675 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6676 + 0 6677 + ] 6678 +} 6679 +))) 6680 + 6681 +((( 6682 + 6683 +))) 6684 + 6685 +((( 6686 +Пример ответа : 6687 +))) 6688 + 6689 +((( 6690 + 6691 +))) 6692 + 6693 +((( 6694 +200 ~/~/ Success 6695 +))) 6696 +))) 6697 + 6698 + 3055 3055 (% class="box" lang="en-US" style="text-align: center;" %) 3056 3056 ((( 3057 3057 (% 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]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content