Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/16 11:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,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,8 +682,256 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 686 686 752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 + 754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 755 + 756 +(% class="box infomessage" %) 757 +((( 758 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 759 +))) 760 + 761 +Метод возвращает полную информацию о модели объекта. 762 + 763 +(% style="color:#000000" %)Метод запроса: **GET** 764 + 765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 766 + 767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 768 + 769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 770 + 771 +(% style="color:#000000" %)Ответ: 772 + 773 +(% style="color:#000000" %){ 774 + "parentName": "string", 775 + "name": "string", 776 + "picture": "string", 777 + "minspeed": 0, 778 + "maxspeed": 0, 779 + "width": 0, 780 + "imbeddedtrailer": true, 781 + "hoppercapacity": 0, 782 + "hopperdischargespeed": 0, 783 + "modelType": 0, 784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 786 + "deleted": true 787 +} 788 + 789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 803 + 804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 805 + 806 +(% class="box successmessage" %) 807 +((( 808 +(% lang="en-US" %)**POST /api/v3/models/find** 809 +))) 810 + 811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 812 + 813 +(% style="color:#000000" %)Метод запроса: **POST** 814 + 815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 816 + 817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 818 + 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 820 + 821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 822 +} 823 + 824 +(% style="color:#000000" %)Ответ: 825 + 826 +(% style="color:#000000" %)[ 827 + { 828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 830 + "parentName": "string", 831 + "name": "string", 832 + "modelType": 0 833 + } 834 +] 835 + 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 844 + 845 +(% class="box successmessage" %) 846 +((( 847 +(% lang="en-US" %)**POST /api/v3/models** 848 +))) 849 + 850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 851 + 852 +(% style="color:#000000" %)Метод запроса: **POST** 853 + 854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 855 + 856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 857 + 858 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 859 + 860 +{ 861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 + "deleted": false, 864 + "extId": "string", 865 + "name": "string", 866 + "picture": "string", 867 + "minspeed": 0, 868 + "maxspeed": 0, 869 + "width": 0, 870 + "imbeddedtrailer": true, 871 + "fueloutlay": 0, 872 + "hoppercapacity": 0, 873 + "hopperdischargespeed": 0, 874 + "modelType": 0 875 +} 876 + 877 +Ответ: 878 + 879 +{ 880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 + "deleted": false, 883 + "extId": "string", 884 + "name": "string", 885 + "picture": "string", 886 + "minspeed": 0, 887 + "maxspeed": 0, 888 + "width": 0, 889 + "imbeddedtrailer": true, 890 + "hoppercapacity": 0, 891 + "hopperdischargespeed": 0, 892 + "modelType": 0 893 +} 894 + 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 910 + 911 +(% class="box warningmessage" %) 912 +((( 913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 +))) 915 + 916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 917 + 918 +(% style="color:#000000" %)Метод запроса: **PUT** 919 + 920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 921 + 922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 923 + 924 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 925 + 926 +{ 927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 929 + "deleted": true, 930 + "extId": "string", 931 + "name": "string", 932 + "picture": "string", 933 + "minspeed": 0, 934 + "maxspeed": 0, 935 + "width": 0, 936 + "imbeddedtrailer": true, 937 + "fueloutlay": 0, 938 + "hoppercapacity": 0, 939 + "hopperdischargespeed": 0, 940 + "modelType": 0 941 +} 942 + 943 +Ответ: 944 + 945 +{ 946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 948 + "deleted": true, 949 + "extId": "string", 950 + "name": "string", 951 + "picture": "string", 952 + "minspeed": 0, 953 + "maxspeed": 0, 954 + "width": 0, 955 + "imbeddedtrailer": true, 956 + "fueloutlay": 0, 957 + "hoppercapacity": 0, 958 + "hopperdischargespeed": 0, 959 + "modelType": 0 960 +} 961 + 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 977 + 978 +(% class="box errormessage" %) 979 +((( 980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 +))) 982 + 983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 + 985 +(% style="color:#000000" %)Метод запроса: **DELETE** 986 + 987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 988 + 989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 990 + 991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 992 + 993 +Ответ: В случае успеха **Success 200** 994 + 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 996 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -711,6 +711,17 @@ 711 711 712 712 ((( 713 713 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 714 714 "vehicleId": "", ~/~/ ID объекта 715 715 "name": "", ~/~/ Имя объекта 716 716 "imei": "", ~/~/ IMEI объекта ... ... @@ -718,19 +718,15 @@ 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 720 "sim2": "", ~/~/ Номер SIM2 721 - 722 722 "parentId": "", ~/~/ ID клиента-родителя 723 723 "parentName": "", ~/~/ Наименование клиента-родителя 724 724 "modelId": "", ~/~/ ID модели объекта 725 725 "modelName": "", ~/~/ Имя модели объекта 726 - 727 727 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 728 "unitName": "string", ~/~/ Наименование подразделения 729 729 "status": 0, ~/~/ Статус объекта 730 - 731 731 "createdAt": "", ~/~/ Дата создания объекта 732 732 }, 733 - 734 734 "customFields": [ ~/~/ Произвольные поля 735 735 { 736 736 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -753,8 +753,7 @@ 753 753 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 754 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 755 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 758 758 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 759 "mileageCoeff": 0, ~/~/ коэффициент пробега 760 760 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -784,7 +784,6 @@ 784 784 "retries": 0 ~/~/ Количество попыток 785 785 } 786 786 ], 787 - 788 788 "sensors": [ ~/~/ Датчики 789 789 { 790 790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -811,6 +811,7 @@ 811 811 ], 812 812 "showInTooltip": true, ~/~/ Отображать в подсказке 813 813 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 814 814 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 815 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 816 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -825,31 +825,19 @@ 825 825 }, 826 826 827 827 ~/~/ Характерные для произвольного: 828 - 829 829 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 830 - 831 831 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 832 - 833 833 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 834 - 835 835 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 836 - 837 837 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 838 - 839 839 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 840 - 841 841 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 842 - 843 843 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 844 - 845 845 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 846 - 847 847 ~/~/ "ValueOn": "Вкл.", 848 - 849 849 ~/~/ "ValueOff": "Выкл." 850 850 "summaryMaxValue": 0 ~/~/ Макс. значение 851 851 } 852 - 853 853 "drivers": [ ~/~/ Водители 854 854 { 855 855 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -858,7 +858,6 @@ 858 858 "isDefault": true ~/~/ По умолчанию 859 859 } 860 860 ], 861 - 862 862 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 863 863 { 864 864 "id": "", ~/~/ ID задания ... ... @@ -875,19 +875,27 @@ 875 875 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 876 876 } 877 877 ], 878 - 879 - "statusHistory": [ ~/~/ История статусов 1181 +"statusHistory": [ ~/~/ История статусов 880 880 { 881 881 "status": 0, 882 882 "date": "2023-05-22T09:57:39.562Z", 883 883 "description": "string", 884 884 "additionalInfo": "string" 885 - } 886 - ] 887 887 1188 +((( 888 888 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 889 889 ))) 890 890 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 891 891 (% style="text-align:left" %) 892 892 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 893 893 ... ... @@ -894,6 +894,75 @@ 894 894 (% style="text-align:left" %) 895 895 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 896 896 1208 + 1209 +== **Отправить команду на терминал** == 1210 + 1211 +(% class="box successmessage" %) 1212 +((( 1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1214 +))) 1215 + 1216 +Команда для отправки на тс. 1217 + 1218 +{ 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1223 +} 1224 + 1225 +В ответ получаем cmdid 1226 + 1227 + 1228 +== **Получить ответ на отправленную на ТС команду** == 1229 + 1230 +(% class="box infomessage" %) 1231 +((( 1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1233 +))) 1234 + 1235 +Идентификатор команды: cmdId 1236 + 1237 +Запрос от терминала на ответ команды 1238 + 1239 +Пример ответ от терминала: 1240 + 1241 +ID= "" ~/~/ идентификатор объекта 1242 +Soft="" ~/~/ версия софта 1243 +GPS=4 ~/~/ тип трекера 1244 +Time=11:05:43 28.06.24 ~/~/ время запроса 1245 +Lat=45.056221 ~/~/ широта 1246 +Lon=39.035938 ~/~/ долгота 1247 +Speed=0.0 ~/~/ скорость 1248 +Course=181.4 ~/~/направление 1249 + 1250 +((( 1251 +== **Список отправленных объекту команд с ответами** == 1252 + 1253 +(% class="box infomessage" %) 1254 +((( 1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1256 +))) 1257 + 1258 +Идентификатор ТС: vehicleId 1259 + 1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1261 + 1262 +Пример ответа терминала 1263 + 1264 +[ 1265 +{ 1266 +"id": "", ~/~/ идентификатор пользователя 1267 +"commandText": "", ~/~/Текст команды. 1268 +"templateId": "", ~/~/Идентификатор шаблона 1269 +"updated": "", ~/~/ Время отправки 1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1271 +"answer": "", ~/~/ Ответ терминала. 1272 +"status": "" ~/~/ Статус отправки 1273 +} 1274 +] 1275 +))) 1276 + 897 897 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 898 898 899 899 (% class="box successmessage" %) ... ... @@ -913,6 +913,11 @@ 913 913 914 914 (% style="color:#000000" %){ 915 915 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 916 916 "parentId": "" , ~/~/ ID клиента 917 917 "name": "" , ~/~/ имя ТС 918 918 "imei": "" , ~/~/ IMEI ... ... @@ -933,7 +933,6 @@ 933 933 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 934 934 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 935 935 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 936 - 937 937 "mileageCalcMethod": 0, 938 938 "mileageCoeff": 0, 939 939 "locationByCellId": true, ... ... @@ -966,7 +966,6 @@ 966 966 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 967 967 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 968 968 } 969 - 970 970 "drivers": [ ~/~/ Водители 971 971 { 972 972 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -981,8 +981,7 @@ 981 981 "retries": 0 982 982 } 983 983 ], 984 - 985 - "sensors": [ ~/~/ Датчики 1367 +"sensors": [ ~/~/ Датчики 986 986 { 987 987 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 988 988 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1008,6 +1008,7 @@ 1008 1008 ], 1009 1009 "showInTooltip": true, ~/~/ Отображать в подсказке 1010 1010 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1011 1011 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1012 1012 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1013 1013 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1020,103 +1020,222 @@ 1020 1020 "additionalProp2": "string", 1021 1021 "additionalProp3": "string" 1022 1022 }, 1023 - 1024 1024 ~/~/ Характерные для произвольного: 1025 - 1026 1026 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1027 - 1028 1028 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1029 - 1030 1030 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1031 - 1032 1032 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1033 - 1034 1034 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1035 - 1036 1036 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1037 - 1038 1038 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1039 - 1040 1040 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1041 - 1042 1042 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1043 - 1044 1044 ~/~/ "ValueOn": "Вкл.", 1045 - 1046 1046 ~/~/ "ValueOff": "Выкл." 1047 - "summaryMaxValue": 0 ~/~/ Макс. значение 1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1419 + 1420 +((( 1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1422 + { 1423 + "from": 0, ~/~/ С какого значения 1424 + "color": "string", ~/~/ Каким цветом 1425 + "text": "string" ~/~/ Текст подписи к этому интервалу 1426 + } 1427 + ] 1048 1048 } 1049 1049 ], 1430 +))) 1431 + 1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1433 + 1434 + 1050 1050 "customFields": [ ~/~/ Произвольные поля 1051 1051 { 1052 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1053 - "name": "string", 1054 - "value": "string", 1055 - "forClient": true, 1056 - "forTooltip": true, 1057 - "forReport": true 1058 - } 1059 - ] 1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1438 + "name": "string", ~/~/ Наименование произвольного поля 1439 + "value": "string", ~/~/ Значение произвольного поля 1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1060 1060 } 1453 +))) 1061 1061 1455 + 1062 1062 (% style="color:#000000" %)Ответ: 1063 1063 1064 -(% style="color:#000000" %){ 1065 1065 1066 - "vehicleId": "", ~/~/ID ТС 1067 - "parentId": "", ~/~/Guid владельца ТС 1068 - "name": "", ~/~/Имя объекта 1069 - "imei": "", ~/~/IMEI 1070 - "deviceTypeId": "", ~/~/ID типа устройства 1071 - "modelId": "", ~/~/ID модели 1072 - "unitId": "", ~/~/ID подразделения 1073 - "sim1": "", ~/~/SIM1 1074 - "sim2": "", ~/~/SIM2 1075 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1076 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1077 - "counters": { ~/~/Счётчики 1078 - "mileageEnabled": true, 1079 - "motohoursEnabled": true, 1080 - "mileage": "", 1081 - "motohours": 345.0 1082 - }, 1083 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1084 - "id": null, 1085 - "enabled": true, ~/~/флаг включения 1086 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1087 - "login": "", ~/~/ имя учетной записи 1088 - "password": "" ~/~/ пароль учетной записи 1089 - }, 1090 - "inspectionTasks": { ~/~/ задания на ТО 1091 - "id": "", ~/~/ ID задачи 1092 - "enabled": false, ~/~/ Признак включения 1093 - "name": "", ~/~/ Имя задания 1094 - "description": "", ~/~/ Описание задания 1095 - "mileageCondition": "", ~/~/ Условие по пробегу 1096 - "lastMileage": "", ~/~/ Пробег (в метрах) 1097 - "motohoursCondition": "", ~/~/ Условие по моточасам 1098 - "lastMotohours": "", ~/~/ Моточасы 1099 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1100 - "kind": "", ~/~/ Вид периодичности по времени 1101 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1459 +((( 1460 +((( 1461 +((( 1462 +{ 1463 + "vehicleId": 0, ~/~/ ID ТС 1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1465 + "name": "string", ~/~/ Имя объекта 1466 + "imei": "string", ~/~/ IMEI 1467 + "deviceTypeId": 0, ~/~/ ID типа устройства 1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1470 + "sim1": "string", ~/~/ SIM1 1471 + "sim2": "string", ~/~/ SIM2 1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1474 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1489 + "counters": { ~/~/ Dto для состояний счётчиков 1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1492 + "mileage": 0, ~/~/ Пробег 1493 + "motohours": 0 ~/~/ Моточасы 1494 + }, 1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1496 + "id": "string", ~/~/ CMSV6 Идентификатор 1497 + "enabled": true, ~/~/ Признак включения 1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1499 + "login": "string", ~/~/ CMSV6 имя учетной записи 1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1501 + }, 1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1503 + { 1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1505 + "enabled": true, ~/~/ Признак включения 1506 + "name": "string", ~/~/ Имя задания 1507 + "description": "string", ~/~/ Описание задания 1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1102 1102 } 1517 + ], 1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1519 + { 1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1521 + "inputNumber": 0, ~/~/ № входа. 1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1523 + "comment": "string", ~/~/ Комментарий 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1528 + } 1529 + ], 1530 + "commandTemplates": [ ~/~/ Список шаблонов команд 1531 + { 1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1533 + "name": "string", ~/~/ Название шаблона команд 1534 + "command": "string", ~/~/ Команда на выполнение 1535 + "retries": 0 ~/~/ Лимит попыток отправки 1536 + } 1537 + ], 1538 + "sensors": [ ~/~/ Список датчиков 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1542 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1543 + "name": "string", ~/~/ Имя датчика 1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1545 + "inputNumber": 0, ~/~/ Номер входа 1546 + "pseudonym": "string", ~/~/ Псевдоним 1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1548 + "isInverted": true, ~/~/ Признак инверсии 1549 + "disabled": true, ~/~/ Датчик не участвует в обработке 1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1551 + "gradesTables": [ ~/~/ Тарировка 1552 + { 1553 + "grades": [ ~/~/ Таблицы тарировки 1554 + { 1555 + "input": 0, ~/~/ Вход 1556 + "output": 0 ~/~/ Выход 1557 + } 1558 + ], 1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1560 + } 1561 + ], 1562 + "showInTooltip": true, ~/~/ Отображение в подсказке 1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1567 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1568 + "expr": "string", ~/~/ Выражение 1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1570 + "string" 1571 + ], 1572 + "customParams": { 1573 + "additionalProp1": "string", 1574 + "additionalProp2": "string", 1575 + "additionalProp3": "string" 1576 + }, 1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1578 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1579 + { 1580 + "from": 0, ~/~/ С какого значения 1581 + "color": "string", ~/~/ Каким цветом 1582 +))) 1103 1103 1104 -(% style="text-align:left" %) 1105 -(% style="color:#000000" %)} 1584 +((( 1585 + "text": "string" ~/~/ Текст подписи к этому интервалу 1586 + } 1587 + ] 1588 + } 1589 + ], 1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1591 + "customFields": [ ~/~/ Список произвольных полей 1592 + { 1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1594 + "name": "string", ~/~/ Наименование произвольного поля 1595 + "value": "string", ~/~/ Значение произвольного поля 1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1599 + } 1600 + ], 1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1602 +} 1603 +))) 1604 +))) 1605 +))) 1106 1106 1607 + 1107 1107 **Валидация:** 1108 1108 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1109 1109 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1110 1110 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1111 1111 1112 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1113 1113 1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1615 + 1114 1114 (% class="box infomessage" %) 1115 1115 ((( 1116 1116 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1117 1117 ))) 1118 1118 1119 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1621 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1120 1120 1121 1121 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1122 1122 ... ... @@ -1150,9 +1150,12 @@ 1150 1150 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1151 1151 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1152 1152 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1153 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1154 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1155 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1655 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1656 + "unitName": "string", ~/~/ Название подразделения (опционально) 1657 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1658 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1659 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1156 1156 } 1157 1157 1158 1158 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1159,8 +1159,14 @@ 1159 1159 1160 1160 (% style="color:#000000" %)Ответ: 1161 1161 1162 -(% style="color:#000000" %){ 1667 +(% style="color:#000000" %)[ 1668 +{ 1163 1163 1670 +((( 1671 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1672 +))) 1673 + 1674 +((( 1164 1164 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1165 1165 "name": "" ~/~/ наименование объекта 1166 1166 "imei": "" ~/~/ IMEI объекта ... ... @@ -1186,9 +1186,21 @@ 1186 1186 "forClient": true, ~/~/ право на отображение у клиента 1187 1187 "forTooltip": false, ~/~/ право на отображение в подсказке 1188 1188 "forReport": false ~/~/ право на отображение в отчетах 1189 - }(%%) 1190 -(% style="color:#000000" %)} 1700 +))) 1191 1191 1702 +((( 1703 + } 1704 + ], 1705 + "vehicleGroups": [ ~/~/ Группы ТС 1706 + { 1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1708 + "name": "string" ~/~/ Наименование группы ТС 1709 + } 1710 + ] 1711 + } 1712 +] 1713 +))) 1714 + 1192 1192 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1193 1193 1194 1194 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1220,13 +1220,11 @@ 1220 1220 "data": "", ~/~/ Данные 1221 1221 "overwrite": false, ~/~/ Флаг перезаписи 1222 1222 "stage": "", ~/~/ Состояние, может быть null 1223 - 1224 1224 (% style="color:#000000" %)} 1225 1225 1226 1226 (% style="color:#000000" %)Ответ: 1227 1227 1228 -(% style="color:#000000" %){ 1229 - 1750 +(% style="color:#000000" %){(%%) 1230 1230 "status": "", ~/~/ значение статуса 1231 1231 "date": "", ~/~/ Дата смены статуса 1232 1232 "description": "", ~/~/ Описание ... ... @@ -1233,10 +1233,9 @@ 1233 1233 "data": "", ~/~/ Данные 1234 1234 "overwrite": false, ~/~/ Флаг перезаписи 1235 1235 "stage": "", ~/~/ Состояние 1236 - 1237 -(% style="text-align:left" %) 1238 1238 (% style="color:#000000" %) } 1239 1239 1759 + 1240 1240 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1241 1241 1242 1242 (% class="box warningmessage" %) ... ... @@ -1255,7 +1255,7 @@ 1255 1255 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1256 1256 1257 1257 (% style="color:#000000" %){ 1258 - 1778 + "vehicleId": , ~/~/ ID объекта 1259 1259 "parentId": "" , ~/~/ ID клиента 1260 1260 "name": "" , ~/~/ имя ТС 1261 1261 "imei": "" , ~/~/ IMEI ... ... @@ -1312,9 +1312,19 @@ 1312 1312 1313 1313 "drivers": [ ~/~/ Водители 1314 1314 { 1315 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1316 - "isDefault": true 1317 - } 1835 + 1836 +((( 1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1838 + "inputNumber": 0, ~/~/ № входа. 1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1840 + "comment": "string", ~/~/ Комментарий. 1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1845 +))) 1846 + 1847 + } 1318 1318 ], 1319 1319 "commandTemplates": [ ~/~/ Шаблон команды 1320 1320 { ... ... @@ -1324,8 +1324,7 @@ 1324 1324 "retries": 0 1325 1325 } 1326 1326 ], 1327 - 1328 - "sensors": [ ~/~/ Датчики 1857 +"sensors": [ ~/~/ Датчики 1329 1329 { 1330 1330 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1331 1331 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1351,6 +1351,11 @@ 1351 1351 ], 1352 1352 "showInTooltip": true, ~/~/ Отображать в подсказке 1353 1353 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1883 + 1884 +((( 1885 + "color": "string",** ~/~/ **Цвет датчика 1886 +))) 1887 + 1354 1354 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1355 1355 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1356 1356 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1363,95 +1363,225 @@ 1363 1363 "additionalProp2": "string", 1364 1364 "additionalProp3": "string" 1365 1365 }, 1366 - 1367 1367 ~/~/ Характерные для произвольного: 1368 - 1369 1369 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1370 - 1371 1371 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1372 - 1373 1373 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1374 - 1375 1375 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1376 - 1377 1377 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1378 - 1379 1379 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1380 - 1381 1381 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1382 - 1383 1383 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1384 - 1385 1385 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1386 - 1387 1387 ~/~/ "ValueOn": "Вкл.", 1388 - 1389 1389 ~/~/ "ValueOff": "Выкл." 1390 1390 "summaryMaxValue": 0 ~/~/ Макс. значение 1913 + 1914 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1915 + { 1916 + "from": 0, ~/~/ С какого значения 1917 + "color": "string", ~/~/ Каким цветом 1918 + "text": "string" ~/~/ Текст подписи к этому интервалу 1919 + } 1920 + ] 1391 1391 } 1392 1392 ], 1923 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1924 + 1393 1393 "customFields": [ ~/~/ Произвольные поля 1394 - { 1395 - 1396 - "name": "string", 1397 - "value": "string", 1398 - "forClient": true, 1399 - "forTooltip": true, 1400 - "forReport": true 1926 + { 1927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1928 + "name": "string", ~/~/ Наименование произвольного поля 1929 + "value": "string", ~/~/ Значение произвольного поля 1930 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1931 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1932 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1401 1401 } 1402 - ] 1934 + 1935 +((( 1936 + ], 1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1938 +))) 1939 + 1403 1403 } 1404 1404 1942 + 1405 1405 (% style="color:#000000" %)Ответ: 1406 1406 1407 -(% lang="en-US" style="text-align:left" %) 1408 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1945 +((( 1946 +{ 1947 + "vehicleId": 0, ~/~/ ID ТС 1948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1949 + "name": "string", ~/~/ Имя объекта 1950 + "imei": "string", ~/~/ IMEI 1951 + "deviceTypeId": 0, ~/~/ ID типа устройства 1952 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1954 + "sim1": "string", ~/~/ SIM1 1955 + "sim2": "string", ~/~/ SIM2 1956 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1957 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1958 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1959 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1960 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1961 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1962 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1963 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1964 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1965 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1966 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1967 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1968 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1969 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1970 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1971 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1972 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1973 + "counters": { ~/~/ состояний счётчиков 1974 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1975 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1976 + "mileage": 0, ~/~/ Пробег 1977 + "motohours": 0 ~/~/ Моточасы 1978 + }, 1979 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1980 + "id": "string", ~/~/ CMSV6 Идентификатор 1981 + "enabled": true, ~/~/ Признак включения 1982 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1983 +))) 1409 1409 1410 -(% lang="en-US" style="text-align:left" %) 1411 - "vehicleId": "", ~/~/ ID ТС 1412 - "parentId": "", ~/~/ ID клиента 1413 - "name": "", ~/~/ имя ТС 1414 - "imei": "", ~/~/ IMEI 1415 - "deviceTypeId": "", ~/~/ типа устройства 1416 - "modelId": "", ~/~/ ID модели 1417 - "unitId": "", ~/~/ ID подразделения 1418 - "sim1": "", ~/~/ SIM 1 1419 - "sim2": "", ~/~/ SIM2 1420 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1421 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1422 - "counters": 1423 - { 1424 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1425 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1426 - "mileage": "", ~/~/ пробег 1427 - "motohours": "", ~/~/ моточасы 1428 - } 1429 - "cmsv6Parameters": ~/~/ параметры CMSv6 1985 + 1986 +((( 1987 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1988 + "login": "string", ~/~/ CMSV6 имя учетной записи 1989 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1990 + }, 1991 + "inspectionTasks": [ ~/~/ Задания на ТО 1992 + { 1993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1994 + "enabled": true, ~/~/ Признак включения 1995 + "name": "string", ~/~/ Имя задания 1996 + "description": "string", ~/~/ Описание задания 1997 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1998 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1999 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2000 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2001 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2002 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2003 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2004 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2005 + } 2006 + ], 2007 + "drivers": [ ~/~/ Список водителей 2008 + { 2009 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2010 + "inputNumber": 0, ~/~/ № входа. 2011 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2012 + "comment": "string", ~/~/ Комментарий. 2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2014 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2015 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2016 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2017 + } 2018 + ], 2019 + "commandTemplates": [ ~/~/ Список шаблонов команд 2020 + { 2021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2022 + "name": "string", ~/~/ Название шаблона команд 2023 + "command": "string", ~/~/ Команда на выполнение 2024 + "retries": 0 ~/~/ Лимит попыток отправки 2025 + } 2026 + ], 2027 + "sensors": [ ~/~/ Список датчиков 2028 + { 2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2030 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2031 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2032 +))) 2033 + 2034 +((( 2035 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2036 +))) 2037 + 2038 +((( 2039 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2040 +))) 2041 + 2042 +((( 2043 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2044 +))) 2045 + 2046 +((( 2047 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2048 +))) 2049 + 2050 +((( 2051 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2052 + "name": "string", ~/~/ Имя датчика 2053 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2058 + "inputNumber": 0, ~/~/ Номер входа 2059 + "pseudonym": "string", ~/~/ Псевдоним 2060 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2061 + "isInverted": true, ~/~/ Признак инверсии 2062 + "disabled": true, ~/~/ Датчик не участвует в обработке 2063 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2064 + "gradesTables": [ ~/~/ Тарировка 1430 1430 { 1431 - "id": ~/~/ идентификатор 1432 - "enabled": true, ~/~/ флаг включения 1433 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1434 - "login": "", ~/~/ имя учетной записи 1435 - "password": "", ~/~/ пароль учетной записи 1436 - } 1437 - "inspectionTasks": ~/~/ задания на ТО 1438 - { 1439 - "id": "", ~/~/ ID задания 1440 - "enabled": false, ~/~/ Признак включения 1441 - "name": "", ~/~/ Имя задания 1442 - "description": "", ~/~/ Описание задания 1443 - "mileageCondition": "", ~/~/ Условие по пробегу 1444 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1445 - "motohoursCondition": "", ~/~/ Условие по моточасам 1446 - "lastMotohours": "", ~/~/ Моточасы 1447 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1448 - "kind": "", ~/~/ Вид периодичности по времени 1449 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2066 + "grades": [ ~/~/ Таблицы тарировки 2067 + { 2068 + "input": 0, ~/~/ Вход 2069 + "output": 0 ~/~/ Выход 2070 + } 2071 + ], 2072 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1450 1450 } 2074 + ], 2075 + "showInTooltip": true, ~/~/ Отображение в подсказке 2076 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1451 1451 1452 -(% lang="en-US" style="text-align:left" %) 1453 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2078 +((( 2079 + "color": "string", ~/~/ цвет уведомлений 2080 +))) 1454 1454 2082 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2083 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2084 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2085 + "expr": "string", ~/~/ Выражение 2086 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2087 + "string" 2088 + ], 2089 + "customParams": { ~/~/ Дополнительные настройки 2090 + "additionalProp1": "string", 2091 + "additionalProp2": "string", 2092 + "additionalProp3": "string" 2093 + }, 2094 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2095 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2096 + { 2097 + "from": 0, ~/~/ С какого значения 2098 + "color": "string", ~/~/ Каким цветом 2099 + "text": "string" ~/~/ Текст подписи к этому интервалу 2100 + } 2101 + ] 2102 + } 2103 + ], 2104 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2105 + "customFields": [ ~/~/ Список произвольных полей 2106 + { 2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2108 + "name": "string", ~/~/ Наименование произвольного поля 2109 + "value": "string", ~/~/ Значение произвольного поля 2110 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2111 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2112 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2113 + } 2114 + ], 2115 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2116 +} 2117 +))) 2118 + 1455 1455 **Валидация:** 1456 1456 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1457 1457 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1490,18 +1490,15 @@ 1490 1490 1491 1491 (% style="color:#000000" %)Метод запроса: **GET** 1492 1492 1493 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2157 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1494 1494 1495 1495 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1496 1496 1497 1497 (% style="color:#000000" %)Ответ: 1498 1498 1499 -(% style="color:#000000" %){ 1500 - 2163 +(% style="color:#000000" %){(%%) 1501 1501 "deviceTypeId" : "", ~/~/ ID типа устройства 1502 1502 "deviceTypeName" : "" ~/~/ Название типа устройства 1503 - 1504 -(% style="text-align:left" %) 1505 1505 (% style="color:#000000" %)} 1506 1506 1507 1507 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1523,13 +1523,10 @@ 1523 1523 1524 1524 (% style="color:#000000" %)Ответ: 1525 1525 1526 -(% style="color:#000000" %){ 1527 - 2187 +(% style="color:#000000" %){(%%) 1528 1528 "id": "", ~/~/ ID типа датчика 1529 1529 "name": "", ~/~/ Название 1530 1530 "description": "", ~/~/ Описание 1531 - 1532 -(% style="text-align:left" %) 1533 1533 (% style="color:#000000" %)} 1534 1534 1535 1535 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1573,6 +1573,56 @@ 1573 1573 } 1574 1574 ] 1575 1575 2234 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2235 + 2236 +(% class="box infomessage" style="text-align: left;" %) 2237 +((( 2238 +**POST /api/v3/terminalMessages/mapping** 2239 +))) 2240 + 2241 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2242 + 2243 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2244 + 2245 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2246 + 2247 +{ 2248 + "protocolType": 0, 2249 + "params": ["string"] 2250 +} 2251 + 2252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2253 +|protocolType|ID типа протокола 2254 +|params|((( 2255 +Массив наименований параметров в сообщении 2256 +))) 2257 + 2258 +Ответ: 2259 + 2260 +{ 2261 + "protocolType": 0, 2262 + "mapping": { 2263 + "additionalProp1": { 2264 + "inputType": 0, 2265 + "inputNumber": 0 2266 + }, 2267 + "additionalProp2": { 2268 + "inputType": 0, 2269 + "inputNumber": 0 2270 + } 2271 + } 2272 +} 2273 + 2274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2275 +|protocolType|Тип протокола 2276 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2277 +|inputNumber|((( 2278 +Номер входа 2279 +))) 2280 + 2281 +(% class="wikigeneratedid" %) 2282 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2283 + 1576 1576 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1577 1577 1578 1578 (% class="box infomessage" %) ... ... @@ -1597,6 +1597,11 @@ 1597 1597 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1598 1598 } 1599 1599 2308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2309 +|vehicleId|ID объекта 2310 +|from|Дата и время начала периода запроса 2311 +|to|Дата и время окончания периода запроса 2312 + 1600 1600 Ответ: 1601 1601 1602 1602 [ ... ... @@ -1603,25 +1603,313 @@ 1603 1603 { 1604 1604 "messages": [ 1605 1605 { 1606 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1607 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1608 - "speed": 0, ~/~/ Скорость, км/ч 1609 - "altitude": 0, ~/~/ Высота, м 1610 - "latitude": 0, ~/~/ Широта [-90°;90°] 1611 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1612 - "satellites": 0, ~/~/ Кол-во спутников 1613 - "voltage": 0, ~/~/ Напряжение 1614 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2319 + "deviceTime": "2023-11-29T07:40:44.052Z", 2320 + "serverTime": "2023-11-29T07:40:44.052Z", 2321 + "speed": 0, 2322 + "altitude": 0, 2323 + "latitude": 0, 2324 + "longitude": 0, 2325 + "satellites": 0, 2326 + "course": 0, 2327 + "voltage": 0, 2328 + "parameters": { 1615 1615 "additionalProp1": "string", 1616 1616 "additionalProp2": "string", 1617 1617 "additionalProp3": "string" 1618 1618 }, 1619 - "photoCount": 0 ~/~/ Кол-во фото 2333 + "photoCount": 0, 2334 + "lbsCorrectedCoords": true, 2335 + "protocolType": 0 1620 1620 } 1621 1621 ] 1622 1622 } 1623 1623 ] 1624 1624 2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2342 +|deviceTime|Время сообщения терминала 2343 +|serverTime|Время когда сообщение поступило на сервер 2344 +|speed|Скорость 2345 +|altitude|Высота над уровнем моря 2346 +|latitude|Широта 2347 +|longitude|Долгота 2348 +|satellites|Кол-во спутников 2349 +|course|Курс 2350 +|voltage|Бортовое напряжение 2351 +|parameters|Список параметров и их значений 2352 +|photoCount|Количество фото 2353 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2354 +|protocolType|ID типа протокола 2355 + 2356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2357 + 2358 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2359 + 2360 +(% class="box infomessage" %) 2361 +((( 2362 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2363 +))) 2364 + 2365 +(% style="color:#000000" %)Метод запроса: **POST** 2366 + 2367 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2368 + 2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2370 + 2371 +(% style="text-align:left" %) 2372 +Тело запроса: 2373 + 2374 +{ 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2376 + "vehicleIds": [0], ~/~/ Список ID объектов 2377 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2378 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2379 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2380 +} 2381 + 2382 +Ответ: 2383 + 2384 +[ 2385 + { 2386 + "vehicleId": 0, ~/~/ ID объекта 2387 + "name": "string", ~/~/ Имя ТС 2388 + "periods": [ ~/~/ Периоды 2389 + { 2390 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2391 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2392 + "mileage": 0, ~/~/ Пробег за период, километры 2393 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2394 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2395 + "motohours": 0, ~/~/ Моточасы за период, секунды 2396 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2397 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2398 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2399 + 2400 + } 2401 + ] 2402 + } 2403 +] 2404 + 2405 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2406 + 2407 +(% class="box infomessage" %) 2408 +((( 2409 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2410 +))) 2411 + 2412 +(% style="color:#000000" %)Метод запроса: **POST** 2413 + 2414 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2415 + 2416 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2417 + 2418 +(% style="text-align:left" %) 2419 +Тело запроса: 2420 + 2421 +{ 2422 + "vehicleIds": [0], ~/~/ Список ID объектов 2423 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2424 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2425 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2426 +} 2427 + 2428 +Ответ: 2429 + 2430 +[ 2431 + { 2432 + "vehicleId": 0, ~/~/ ID объекта 2433 + "name": "string", ~/~/ Имя ТС 2434 + "periods": [ ~/~/ Периоды 2435 + { 2436 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2437 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2438 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2439 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2440 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2441 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2442 + "fuelConsumption": 0, ~/~/ Расход топлива 2443 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2444 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2445 + 2446 + } 2447 + ] 2448 + } 2449 +] 2450 + 2451 +(% class="box warningmessage" %) 2452 +((( 2453 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2454 +))) 2455 + 2456 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2457 + 2458 +(% class="box infomessage" %) 2459 +((( 2460 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2461 +))) 2462 + 2463 +(% style="color:#000000" %)Метод запроса: **POST** 2464 + 2465 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2466 + 2467 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2468 + 2469 +(% style="text-align:left" %) 2470 +Тело запроса: 2471 + 2472 +{ 2473 + "vehicleIds": [0], ~/~/ Список ID объектов 2474 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2475 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2476 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2477 +} 2478 + 2479 +Ответ: 2480 + 2481 +[ 2482 + { 2483 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2484 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2485 + "vehicleId": 0, ~/~/ ID объекта 2486 + "name": "string", ~/~/ Имя объекта 2487 + "model": "string", ~/~/ Модель объекта 2488 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2489 + { 2490 + "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 2491 + 2492 +((( 2493 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2494 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2495 + "valueFuel": 0, ~/~/ Количество 2496 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2497 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2498 +))) 2499 + 2500 +((( 2501 + "latitude": 0, ~/~/ Широта. 2502 + "longitude": 0 ~/~/ Долгота. 2503 +))) 2504 + 2505 + } 2506 + ] 2507 + } 2508 +] 2509 + 2510 + 2511 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2512 + 2513 +(% class="box infomessage" %) 2514 +((( 2515 +**POST /api/v3/vehicles/moveStop** 2516 +))) 2517 + 2518 +Метод запроса: **POST** 2519 + 2520 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2521 + 2522 +В заголовках запроса: X-Auth: Токен авторизации 2523 + 2524 + 2525 +Тело запроса: 2526 + 2527 +{ 2528 + "vehicleIds": [ ], ~/~/ Список ID объектов 2529 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2530 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2531 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2532 +} 2533 + 2534 +Ответ: 2535 + 2536 +[ 2537 + { 2538 + "vehicleId": 0, ~/~/ ID объекта 2539 + "vehicleName": "string", ~/~/ Имя объекта 2540 + "moves": [ ~/~/ Событие движения 2541 + { 2542 + "mileage": 0, ~/~/ Пробег, км 2543 + "eventId": 0, ~/~/ Идентификатор события 2544 + "eventName": "string", ~/~/ Название события 2545 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2546 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2547 + "duration": 0 ~/~/ Продолжительность события, секунд 2548 + } 2549 + ], 2550 + "stops": [ ~/~/ События стоянок 2551 + { 2552 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2553 + "eventId": 0, ~/~/ Идентификатор события 2554 + "eventName": "string", ~/~/ Название события 2555 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2556 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2557 + "duration": 0 ~/~/ Продолжительность события, секунд 2558 + } 2559 + ] 2560 + } 2561 +] 2562 + 2563 + 2564 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2565 + 2566 +(% class="box infomessage" %) 2567 +((( 2568 +**POST /api/v3/vehicles/getlastdata** 2569 +))) 2570 + 2571 +Метод запроса: **POST** 2572 + 2573 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2574 + 2575 +В заголовках запроса: X-Auth: Токен авторизации 2576 + 2577 + 2578 +В массиве указываем id объектов через запятую 2579 + 2580 +Ответ: 2581 + 2582 +[ 2583 + { 2584 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2585 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2586 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2587 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2588 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2589 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2590 + "speed": 31, ~/~/ Скорость объекта 2591 + "course": 116, ~/~/ Курс движения [0;360] 2592 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2593 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2594 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2595 + "geozones": [ ~/~/ Сведения по геозонам. 2596 + { 2597 + "id": 10225647, ~/~/ ID Геозоны 2598 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2599 + }, 2600 + { 2601 + "id": 10282875, ~/~/ ID Геозоны 2602 + "name": "Ё2" ~/~/ Наименование геозоны 2603 + }, 2604 + { 2605 + "id": 10226240, ~/~/ ID Геозоны 2606 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2607 + }, 2608 + { 2609 + "id": 9747869, ~/~/ ID Геозоны 2610 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2611 + }, 2612 + { 2613 + "id": 10221123, ~/~/ ID Геозоны 2614 + "name": "53r" ~/~/ Наименование геозоны 2615 + }, 2616 + { 2617 + "id": 10197638, ~/~/ ID Геозоны 2618 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2619 + } 2620 + ] 2621 + } 2622 + 2623 + 2624 += = 2625 + 1625 1625 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1626 1626 1627 1627 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -1653,7 +1653,7 @@ 1653 1653 "id": 0, ~/~/ ID уведомления 1654 1654 "name": "string", ~/~/ Название уведомления 1655 1655 "active": true, ~/~/ Состояние true - активен, false - деактивирован 1656 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2657 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 1657 1657 "userId": "", ~/~/ Пользователь, создавший уведомление 1658 1658 "parentId": "", ~/~/ Идентификатор клиента 1659 1659 "parentName": "string" ~/~/ Имя клиента ... ... @@ -1660,6 +1660,155 @@ 1660 1660 } 1661 1661 ] 1662 1662 2664 + 2665 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2666 + 2667 +(% class="box infomessage" %) 2668 +((( 2669 +**POST /api/v3/notifications** 2670 +))) 2671 + 2672 +Метод запроса **POST** 2673 + 2674 +(% style="text-align: left;" %) 2675 +(% style="color:#000000" %)Пример запроса 2676 + 2677 +((( 2678 +{ 2679 + "id": 0, ~/~/ ID правила 2680 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2681 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2682 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2683 + "name": "string", ~/~/ Имя правила 2684 + "active": true, ~/~/ Активность правила 2685 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2686 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2687 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2688 + ], 2689 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2690 + 0 2691 + ], 2692 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2693 + 0 2694 + ], 2695 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2696 + 0 2697 + ], 2698 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2699 + "additionalProp1": "string", 2700 + "additionalProp2": "string", 2701 + "additionalProp3": "string" 2702 + }, 2703 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2704 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2705 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2706 + ], 2707 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2708 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2709 + "string" 2710 + ], 2711 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2712 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2713 + { 2714 + "id": 0, ~/~/ Идентификатор участника чата. 2715 + "info": "string" ~/~/ Дополнительные сведения. 2716 + } 2717 + ], 2718 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2719 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2720 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2721 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2722 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2723 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2724 + "timezone": 0, ~/~/ часовой пояс 2725 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2726 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2727 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2728 + { 2729 + "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 - Срок действия правила истек 2730 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2731 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2732 + "additionalProp1": "string", 2733 + "additionalProp2": "string", 2734 + "additionalProp3": "string" 2735 + } 2736 + } 2737 + ] 2738 +} 2739 +))) 2740 + 2741 +((( 2742 + 2743 +))) 2744 + 2745 +((( 2746 + 2747 +))) 2748 + 2749 +Ответ: 2750 + 2751 +{ 2752 + "id": 0, ~/~/ ID правила 2753 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2754 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2755 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2756 + "name": "string", ~/~/ Имя правила 2757 + "active": true, ~/~/ Активность правила 2758 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2759 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2760 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2761 + ], 2762 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2763 + 0 2764 + ], 2765 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2766 + 0 2767 + ], 2768 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2769 + 0 2770 + ], 2771 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2772 + "additionalProp1": "string", 2773 + "additionalProp2": "string", 2774 + "additionalProp3": "string" 2775 + }, 2776 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2777 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2778 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2779 + ], 2780 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2781 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2782 + "string" 2783 + ], 2784 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2785 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2786 + { 2787 + "id": 0, ~/~/ Идентификатор участника чата. 2788 + "info": "string" ~/~/ Дополнительные сведения. 2789 + } 2790 + ], 2791 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2792 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2793 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2794 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2795 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2796 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2797 + "timezone": 0, ~/~/ часовой пояс 2798 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2799 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2800 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2801 + { 2802 + "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 - Срок действия правила истек 2803 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2804 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2805 + "additionalProp1": "string", 2806 + "additionalProp2": "string", 2807 + "additionalProp3": "string" 2808 + } 2809 + } 2810 + ] 2811 +} 2812 + 1663 1663 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1664 1664 1665 1665 (% class="box infomessage" %) ... ... @@ -1801,6 +1801,32 @@ 1801 1801 1802 1802 Success 1803 1803 2954 + 2955 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2956 + 2957 +(% class="box warningmessage" %) 2958 +((( 2959 +**PUT** /api/v3/notifications/prolongation 2960 +))) 2961 + 2962 +Метод позволяет продлить уведомления. 2963 + 2964 +Метод запроса **PUT** 2965 + 2966 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2967 + 2968 +В заголовках запроса: X-Auth: Токен авторизации. 2969 + 2970 +Тело запроса: 2971 + 2972 +[ 2973 + 2974 +0 2975 + 2976 +] 2977 + 2978 +где 0 идентификатор ids. 2979 + 1804 1804 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1805 1805 1806 1806 (% class="box errormessage" %) ... ... @@ -1827,78 +1827,126 @@ 1827 1827 1828 1828 == (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 1829 1829 1830 -POST /api/v3/Drivers/find 3006 +(% class="box infomessage" %) 3007 +((( 3008 +**POST /api/v3/Drivers/find** 3009 +))) 1831 1831 1832 -Передается: parentId - ID клиента-родителя 3011 +Передается параметр: parentId - ID клиента-родителя 1833 1833 1834 1834 Ответ: 1835 1835 1836 - {{{[3015 +[ 1837 1837 { 1838 - "name": "string", //Определяет наименование 1839 - "description": "string", // Определяет описание 1840 - "hiredate": "2023-06-30T09:37:58.407Z", // Определяет дату найма 1841 - "chopdate": "2023-06-30T09:37:58.407Z", // Определяет дату увольнения 1842 - "exclusive": true, // Определяет признак "Исключительный" 1843 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1844 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1845 - "deleted": true // Признак удаления 3017 + "name": "string", ~/~/ Определяет наименование 3018 + "description": "string", ~/~/ Определяет описание 3019 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3020 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3021 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3022 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3023 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3024 + "deleted": true ~/~/ Признак удаления 1846 1846 } 1847 -] }}}3026 +] 1848 1848 1849 - 1850 1850 == (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 1851 1851 1852 -GET /api/v3/Drivers/{driverGuid} 3030 +(% class="box infomessage" %) 3031 +((( 3032 +**GET /api/v3/Drivers/{driverGuid}** 3033 +))) 1853 1853 1854 -Передается ID водителя 3035 +Передается параметр: ID водителя 1855 1855 1856 1856 Ответ: 1857 1857 1858 -{ {{{1859 - "name": "string", // Определяет наименование 1860 - "description": "string", // Определяет описание 1861 - "hiredate": "2023-06-30T09:33:33.083Z", // Определяет дату найма 1862 - "chopdate": "2023-06-30T09:33:33.083Z", // Определяет дату увольнения 1863 - "exclusive": true, // Определяет признак "Исключительный" 1864 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // ID водителя 1865 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Guid родителя 1866 - "deleted": true // Признак удаления 3039 +{ 3040 + "name": "string", ~/~/ Определяет наименование 3041 + "description": "string", ~/~/ Определяет описание 3042 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3043 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3044 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3045 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3046 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3047 + "deleted": true ~/~/ Признак удаления 1867 1867 } 1868 -}}} 1869 1869 1870 - 1871 1871 == (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 1872 1872 1873 -POST /api/v3/Drivers 3052 +(% class="box successmessage" %) 3053 +((( 3054 +**POST /api/v3/Drivers** 3055 +))) 1874 1874 1875 - Передается:3057 +Запрос: 1876 1876 1877 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:05.949Z", "chopdate": "2023-06-30T09:43:05.949Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 3059 +{ 3060 + "name": "string", 3061 + "description": "string", 3062 + "hiredate": "2023-06-30T12:50:54.020Z", 3063 + "chopdate": "2023-06-30T12:50:54.020Z", 3064 + "exclusive": true, 3065 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3067 + "deleted": true 3068 +} 1878 1878 1879 1879 Ответ: 1880 1880 1881 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:43:06.014Z", "chopdate": "2023-06-30T09:43:06.014Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 3072 +{ 3073 + "name": "string", 3074 + "description": "string", 3075 + "hiredate": "2023-06-30T12:50:54.051Z", 3076 + "chopdate": "2023-06-30T12:50:54.051Z", 3077 + "exclusive": true, 3078 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3079 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3080 + "deleted": true 3081 +} 1882 1882 1883 1883 1884 1884 == (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 1885 1885 1886 -PUT /api/v3/Drivers 3086 +(% class="box warningmessage" %) 3087 +((( 3088 +**PUT /api/v3/Drivers** 3089 +))) 1887 1887 1888 - Передается:3091 +Запрос: 1889 1889 1890 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.382Z", "chopdate": "2023-06-30T09:45:41.382Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 3093 +{ 3094 + "name": "string", 3095 + "description": "string", 3096 + "hiredate": "2023-06-30T12:50:27.910Z", 3097 + "chopdate": "2023-06-30T12:50:27.910Z", 3098 + "exclusive": true, 3099 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3100 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 + "deleted": true 3102 +} 1891 1891 1892 1892 Ответ: 1893 1893 1894 -{{{{ "name": "string", "description": "string", "hiredate": "2023-06-30T09:45:41.433Z", "chopdate": "2023-06-30T09:45:41.433Z", "exclusive": true, "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "deleted": true }}}} 3106 +{ 3107 + "name": "string", 3108 + "description": "string", 3109 + "hiredate": "2023-06-30T12:50:27.929Z", 3110 + "chopdate": "2023-06-30T12:50:27.929Z", 3111 + "exclusive": true, 3112 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3113 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3114 + "deleted": true 3115 +} 1895 1895 1896 1896 1897 1897 == (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 1898 1898 1899 -DELETE /api/v3/Drivers/{driverGuid} 3120 +(% class="box errormessage" %) 3121 +((( 3122 +**DELETE /api/v3/Drivers/{driverGuid}** 3123 +))) 1900 1900 1901 -Передается ID водителя 3125 +Передается параметр: ID водителя 1902 1902 1903 1903 Ответ: 1904 1904 ... ... @@ -1911,15 +1911,24 @@ 1911 1911 1912 1912 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 1913 1913 1914 -POST /api/v3/DriversVehiclesAssignments/GetByDrivers 3138 +(% class="box infomessage" %) 3139 +((( 3140 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3141 +))) 1915 1915 1916 - Передаем:3143 +Запрос: 1917 1917 1918 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T09:52:31.196Z", "EndTime": "2023-06-30T09:52:31.196Z" }}}} 3145 +{ 3146 + "Ids": [ 3147 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3148 + ], 3149 + "BeginTime": "2023-06-30T12:49:04.365Z", 3150 + "EndTime": "2023-06-30T12:49:04.365Z" 3151 +} 1919 1919 1920 1920 Ответ: 1921 1921 1922 - {{{[3155 +[ 1923 1923 { 1924 1924 "VehicleId": 0, 1925 1925 "CreateTime": "2023-06-30T09:52:31.240Z", ... ... @@ -1928,20 +1928,29 @@ 1928 1928 "BeginTime": "2023-06-30T09:52:31.240Z", 1929 1929 "EndTime": "2023-06-30T09:52:31.240Z" 1930 1930 } 1931 -] }}}3164 +] 1932 1932 1933 1933 1934 1934 === (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 1935 1935 1936 -POST /api/v3/DriversVehiclesAssignments/GetByVehicles 3169 +(% class="box infomessage" %) 3170 +((( 3171 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3172 +))) 1937 1937 1938 - Передаем:3174 +Запрос: 1939 1939 1940 -{{{{ "Ids": [ 0 ], "BeginTime": "2023-06-30T09:54:01.583Z", "EndTime": "2023-06-30T09:54:01.583Z" }}}} 3176 +{ 3177 + "Ids": [ 3178 + 0 3179 + ], 3180 + "BeginTime": "2023-06-30T12:48:39.419Z", 3181 + "EndTime": "2023-06-30T12:48:39.419Z" 3182 +} 1941 1941 1942 1942 Ответ: 1943 1943 1944 - {{{[3186 +[ 1945 1945 { 1946 1946 "VehicleId": 0, 1947 1947 "CreateTime": "2023-06-30T09:54:01.631Z", ... ... @@ -1950,30 +1950,33 @@ 1950 1950 "BeginTime": "2023-06-30T09:54:01.631Z", 1951 1951 "EndTime": "2023-06-30T09:54:01.631Z" 1952 1952 } 1953 -] }}}3195 +] 1954 1954 1955 1955 1956 1956 === (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 1957 1957 1958 -POST /api/v3/DriversVehiclesAssignments 3200 +(% class="box successmessage" %) 3201 +((( 3202 +**POST /api/v3/DriversVehiclesAssignments** 3203 +))) 1959 1959 1960 1960 Передается массив назначений 1961 1961 1962 1962 Запрос: 1963 1963 1964 - {{{[3209 +[ 1965 1965 { 1966 - "VehicleId": 0, // Идентификатор объекта 1967 - "CreateTime": "2023-06-30T11:04:46.902Z", // Момент времени создания назначения 1968 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 1969 - "BeginTime": "2023-06-30T11:04:46.902Z", // Момент времени начала назначения 1970 - "EndTime": "2023-06-30T11:04:46.902Z" // Момент времени окончания назначения. Необязательно. 3211 + "VehicleId": 0, ~/~/ Идентификатор объекта 3212 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3213 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3214 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3215 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 1971 1971 } 1972 -] }}}3217 +] 1973 1973 1974 1974 Ответ: 1975 1975 1976 - {{{[3221 +[ 1977 1977 { 1978 1978 "VehicleId": 0, 1979 1979 "CreateTime": "2023-06-30T11:04:46.903Z", ... ... @@ -1982,29 +1982,32 @@ 1982 1982 "BeginTime": "2023-06-30T11:04:46.903Z", 1983 1983 "EndTime": "2023-06-30T11:04:46.903Z" 1984 1984 } 1985 -] }}}3230 +] 1986 1986 1987 1987 1988 1988 === (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 1989 1989 1990 -PUT /api/v3/DriversVehiclesAssignments 3235 +(% class="box warningmessage" %) 3236 +((( 3237 +**PUT /api/v3/DriversVehiclesAssignments** 3238 +))) 1991 1991 1992 1992 Запрос: 1993 1993 1994 - {{{[3242 +[ 1995 1995 { 1996 1996 "VehicleId": 0, 1997 1997 "CreateTime": "2023-06-30T11:14:08.117Z", 1998 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 3246 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 1999 1999 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2000 2000 "BeginTime": "2023-06-30T11:14:08.117Z", 2001 2001 "EndTime": "2023-06-30T11:14:08.117Z" 2002 2002 } 2003 -] }}}3251 +] 2004 2004 2005 2005 Ответ: 2006 2006 2007 - {{{[3255 +[ 2008 2008 { 2009 2009 "VehicleId": 0, 2010 2010 "CreateTime": "2023-06-30T11:14:53.349Z", ... ... @@ -2013,38 +2013,25 @@ 2013 2013 "BeginTime": "2023-06-30T11:14:53.349Z", 2014 2014 "EndTime": "2023-06-30T11:14:53.349Z" 2015 2015 } 2016 -] }}}3264 +] 2017 2017 2018 2018 2019 2019 === (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 2020 2020 2021 -DELETE /api/v3/DriversVehiclesAssignments 3269 +(% class="box errormessage" %) 3270 +((( 3271 +**DELETE /api/v3/DriversVehiclesAssignments** 3272 +))) 2022 2022 2023 2023 Запрос: 2024 2024 2025 -{{{[ 2026 - { 2027 - "VehicleId": 0, 2028 - "CreateTime": "2023-06-30T11:16:08.341Z", 2029 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2030 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2031 - "BeginTime": "2023-06-30T11:16:08.342Z", 2032 - "EndTime": "2023-06-30T11:16:08.342Z" 2033 - } 2034 -]}}} 3276 +[ 3277 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3278 +] 2035 2035 2036 2036 Ответ: 2037 2037 2038 -{{{[ 2039 - { 2040 - "VehicleId": 0, 2041 - "CreateTime": "2023-06-30T11:16:08.344Z", 2042 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2043 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2044 - "BeginTime": "2023-06-30T11:16:08.344Z", 2045 - "EndTime": "2023-06-30T11:16:08.344Z" 2046 - } 2047 -]}}} 3282 +Success 2048 2048 2049 2049 2050 2050 == (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == ... ... @@ -2051,53 +2051,74 @@ 2051 2051 2052 2052 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 2053 2053 2054 -POST /api/v3/DriversRfidsAssignments/GetByDrivers 3289 +(% class="box infomessage" %) 3290 +((( 3291 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3292 +))) 2055 2055 2056 2056 Запрос: 2057 2057 2058 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы водителей ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}} 3296 +{ 3297 + "Ids": [ 3298 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3299 + ], 3300 + "BeginTime": "2023-06-30T12:47:12.162Z", 3301 + "EndTime": "2023-06-30T12:47:12.162Z" 3302 +} 2059 2059 2060 2060 Ответ: 2061 2061 2062 - {{{[3306 +[ 2063 2063 { 2064 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2065 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2066 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 3308 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3309 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3310 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2067 2067 "BeginTime": "2023-06-30T11:19:40.703Z", 2068 2068 "EndTime": "2023-06-30T11:19:40.703Z" 2069 2069 } 2070 -] }}}3314 +] 2071 2071 2072 2072 2073 2073 === (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 2074 2074 2075 -POST /api/v3/DriversRfidsAssignments/GetByDrivers 3319 +(% class="box infomessage" %) 3320 +((( 3321 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3322 +))) 2076 2076 2077 2077 Запрос: 2078 2078 2079 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" // Идентификаторы карт-меток ], "BeginTime": "2023-06-30T11:19:40.702Z", "EndTime": "2023-06-30T11:19:40.702Z" }}}} 3326 +{ 3327 + "Ids": [ 3328 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3329 + ], 3330 + "BeginTime": "2023-06-30T12:47:12.162Z", 3331 + "EndTime": "2023-06-30T12:47:12.162Z" 3332 +} 2080 2080 2081 2081 Ответ: 2082 2082 2083 - {{{[3336 +[ 2084 2084 { 2085 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор метки 2086 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор назначения 2087 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Идентификатор водителя 3338 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3339 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3340 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 2088 2088 "BeginTime": "2023-06-30T11:19:40.703Z", 2089 2089 "EndTime": "2023-06-30T11:19:40.703Z" 2090 2090 } 2091 -] }}}3344 +] 2092 2092 2093 2093 2094 2094 === (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 2095 2095 2096 -POST /api/v3/DriversRfidsAssignments 3349 +(% class="box successmessage" %) 3350 +((( 3351 +**POST /api/v3/DriversRfidsAssignments** 3352 +))) 2097 2097 2098 2098 Запрос: 2099 2099 2100 - {{{[3356 +[ 2101 2101 { 2102 2102 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2103 2103 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2104,11 +2104,11 @@ 2104 2104 "BeginTime": "2023-06-30T11:27:08.635Z", 2105 2105 "EndTime": "2023-06-30T11:27:08.635Z" 2106 2106 } 2107 -] }}}3363 +] 2108 2108 2109 2109 Ответ: 2110 2110 2111 - {{{[3367 +[ 2112 2112 { 2113 2113 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2114 2114 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2116,16 +2116,19 @@ 2116 2116 "BeginTime": "2023-06-30T11:27:08.677Z", 2117 2117 "EndTime": "2023-06-30T11:27:08.677Z" 2118 2118 } 2119 -] }}}3375 +] 2120 2120 2121 2121 2122 2122 === (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 2123 2123 2124 -PUT /api/v3/DriversRfidsAssignments 3380 +(% class="box warningmessage" %) 3381 +((( 3382 +**PUT /api/v3/DriversRfidsAssignments** 3383 +))) 2125 2125 2126 2126 Запрос: 2127 2127 2128 - {{{[3387 +[ 2129 2129 { 2130 2130 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2131 2131 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2133,11 +2133,11 @@ 2133 2133 "BeginTime": "2023-06-30T11:28:43.330Z", 2134 2134 "EndTime": "2023-06-30T11:28:43.330Z" 2135 2135 } 2136 -] }}}3395 +] 2137 2137 2138 2138 Ответ: 2139 2139 2140 - {{{[3399 +[ 2141 2141 { 2142 2142 "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2143 2143 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2145,36 +2145,25 @@ 2145 2145 "BeginTime": "2023-06-30T11:28:43.331Z", 2146 2146 "EndTime": "2023-06-30T11:28:43.331Z" 2147 2147 } 2148 -] }}}3407 +] 2149 2149 2150 2150 2151 2151 === (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 2152 2152 2153 -DELETE /api/v3/DriversRfidsAssignments 3412 +(% class="box errormessage" %) 3413 +((( 3414 +**DELETE /api/v3/DriversRfidsAssignments** 3415 +))) 2154 2154 2155 2155 Запрос: 2156 2156 2157 -{{{[ 2158 - { 2159 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2160 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2161 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2162 - "BeginTime": "2023-06-30T11:28:43.330Z", 2163 - "EndTime": "2023-06-30T11:28:43.330Z" 2164 - } 2165 -]}}} 3419 +[ 3420 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3421 +] 2166 2166 2167 2167 Ответ: 2168 2168 2169 -{{{[ 2170 - { 2171 - "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2172 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2173 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2174 - "BeginTime": "2023-06-30T11:28:43.331Z", 2175 - "EndTime": "2023-06-30T11:28:43.331Z" 2176 - } 2177 -]}}} 3425 +Success 2178 2178 2179 2179 2180 2180 == (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == ... ... @@ -2181,15 +2181,24 @@ 2181 2181 2182 2182 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 2183 2183 2184 -POST /api/v3/DriversFuelCardsAssignments/GetByDrivers 3432 +(% class="box infomessage" %) 3433 +((( 3434 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3435 +))) 2185 2185 2186 2186 Запрос: 2187 2187 2188 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}} 3439 +{ 3440 + "Ids": [ 3441 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3442 + ], 3443 + "BeginTime": "2023-06-30T12:45:10.852Z", 3444 + "EndTime": "2023-06-30T12:45:10.852Z" 3445 +} 2189 2189 2190 2190 Ответ: 2191 2191 2192 - {{{[3449 +[ 2193 2193 { 2194 2194 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2195 2195 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2197,20 +2197,29 @@ 2197 2197 "BeginTime": "2023-06-30T11:58:04.695Z", 2198 2198 "EndTime": "2023-06-30T11:58:04.695Z" 2199 2199 } 2200 -] }}}3457 +] 2201 2201 2202 2202 2203 2203 === (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 2204 2204 2205 -POST /api/v3/DriversFuelCardsAssignments/GetByCards 3462 +(% class="box infomessage" %) 3463 +((( 3464 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3465 +))) 2206 2206 2207 2207 Запрос: 2208 2208 2209 -{{{{ "Ids": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "BeginTime": "2023-06-30T11:58:04.693Z", "EndTime": "2023-06-30T11:58:04.693Z" }}}} 3469 +{ 3470 + "Ids": [ 3471 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3472 + ], 3473 + "BeginTime": "2023-06-30T12:45:10.852Z", 3474 + "EndTime": "2023-06-30T12:45:10.852Z" 3475 +} 2210 2210 2211 2211 Ответ: 2212 2212 2213 - {{{[3479 +[ 2214 2214 { 2215 2215 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2216 2216 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2218,16 +2218,19 @@ 2218 2218 "BeginTime": "2023-06-30T11:58:04.695Z", 2219 2219 "EndTime": "2023-06-30T11:58:04.695Z" 2220 2220 } 2221 -] }}}3487 +] 2222 2222 2223 2223 2224 2224 === (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 2225 2225 2226 -POST /api/v3/DriversFuelCardsAssignments 3492 +(% class="box successmessage" %) 3493 +((( 3494 +**POST /api/v3/DriversFuelCardsAssignments** 3495 +))) 2227 2227 2228 2228 Запрос: 2229 2229 2230 - {{{[3499 +[ 2231 2231 { 2232 2232 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2233 2233 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2234,11 +2234,11 @@ 2234 2234 "BeginTime": "2023-06-30T12:09:53.175Z", 2235 2235 "EndTime": "2023-06-30T12:09:53.175Z" 2236 2236 } 2237 -] }}}3506 +] 2238 2238 2239 2239 Ответ: 2240 2240 2241 - {{{[3510 +[ 2242 2242 { 2243 2243 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2244 2244 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2246,27 +2246,31 @@ 2246 2246 "BeginTime": "2023-06-30T12:09:53.201Z", 2247 2247 "EndTime": "2023-06-30T12:09:53.201Z" 2248 2248 } 2249 -] }}}3518 +] 2250 2250 2251 2251 2252 2252 === (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 2253 2253 2254 -PUT /api/v3/DriversFuelCardsAssignments 3523 +(% class="box warningmessage" %) 3524 +((( 3525 +**PUT /api/v3/DriversFuelCardsAssignments** 3526 +))) 2255 2255 2256 2256 Запрос: 2257 2257 2258 - {{{[3530 +[ 2259 2259 { 2260 2260 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3533 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2261 2261 "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2262 - "BeginTime": "2023-06-30T12:09:53.1 75Z",2263 - "EndTime": "2023-06-30T12:09:53.1 75Z"3535 + "BeginTime": "2023-06-30T12:09:53.201Z", 3536 + "EndTime": "2023-06-30T12:09:53.201Z" 2264 2264 } 2265 -] }}}3538 +] 2266 2266 2267 2267 Ответ: 2268 2268 2269 - {{{[3542 +[ 2270 2270 { 2271 2271 "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2272 2272 "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -2274,141 +2274,241 @@ 2274 2274 "BeginTime": "2023-06-30T12:09:53.201Z", 2275 2275 "EndTime": "2023-06-30T12:09:53.201Z" 2276 2276 } 2277 -] }}}3550 +] 2278 2278 2279 2279 2280 2280 === (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 2281 2281 2282 -DELETE /api/v3/DriversFuelCardsAssignments 3555 +(% class="box errormessage" %) 3556 +((( 3557 +**DELETE /api/v3/DriversFuelCardsAssignments** 3558 +))) 2283 2283 2284 2284 Запрос: 2285 2285 2286 -{{{[ 2287 - { 2288 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2289 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2290 - "BeginTime": "2023-06-30T12:09:53.175Z", 2291 - "EndTime": "2023-06-30T12:09:53.175Z" 2292 - } 2293 -]}}} 3562 +[ 3563 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3564 +] 2294 2294 2295 2295 Ответ: 2296 2296 2297 -{{{[ 3568 +Success 3569 + 3570 + 3571 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3572 + 3573 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3574 + 3575 +(% class="box infomessage" %) 3576 +((( 3577 +**POST /api/v3/Trailers** 3578 +))) 3579 + 3580 +Пример запроса: 3581 + 3582 +{ 3583 + "startDate": "2023-11-14T10:48:03.671Z", 3584 + "endDate": "2023-11-14T10:48:03.671Z", 3585 + "ids": [ 0 ], 3586 + "timezone": 0 3587 +} 3588 + 3589 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3590 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3591 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3592 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3593 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3594 + 3595 +Пример ответа: 3596 + 3597 +[ 2298 2298 { 2299 - "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2300 - "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2301 - "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2302 - "BeginTime": "2023-06-30T12:09:53.201Z", 2303 - "EndTime": "2023-06-30T12:09:53.201Z" 3599 + "SD": "2023-11-14T10:48:03.717Z", 3600 + "ED": "2023-11-14T10:48:03.717Z", 3601 + "id": 0, 3602 + "SLat": 0, 3603 + "SLon": 0, 3604 + "ELat": 0, 3605 + "ELon": 0, 3606 + "mileage": 0 3607 + "Duration": 0 3608 + "Address": "string", 3609 + "Address2": "string", 3610 + "name": "string", 3611 + "rid": "string", 3612 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3613 + "trailer": { 3614 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3615 + "Number": "string", 3616 + "Description": "string", 3617 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3618 + "ExternalID": "string", 3619 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3620 + "CreateTime": "2023-11-14T10:48:03.717Z", 3621 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3622 + "IsDeleted": true 3623 + }, 3624 + "filesCount": 0, 2304 2304 } 2305 -] }}}3626 +] 2306 2306 3628 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3629 +|SD|Дата и время начала события 3630 +|ED|Дата и время окончания события 3631 +|id|ID объекта 3632 +|SLat|Широта начальной координаты 3633 +|SLon|Долгота начальной координаты 3634 +|ELat|Широта конечной координаты 3635 +|ELon|Долгота конечной координаты 3636 +|mileage|Пробег 3637 +|Duration|Продолжительность 3638 +|Address|Адрес начального местоположения 3639 +|Address2|Адрес конечного местоположения 3640 +|name|Имя радиометки 3641 +|rid|Номер радиометки 3642 +|rguid|ID радиометки 3643 +|trailer|Информация об агрегате 3644 +|ModelGuid|ID агрегата 3645 +|Number|Название/номер агрегата 3646 +|Description|Текст примечания агрегата 2307 2307 2308 2308 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2309 2309 2310 2310 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 2311 2311 2312 -POST /api/v3/Rfids/find 3652 +(% class="box infomessage" %) 3653 +((( 3654 +**POST /api/v3/Rfids/find** 3655 +))) 2313 2313 2314 2314 Запрос: 2315 2315 2316 -{ {{{3659 +{ 2317 2317 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2318 -} }}}3661 +} 2319 2319 2320 2320 Ответ: 2321 2321 2322 - {{{[3665 +[ 2323 2323 { 2324 2324 "name": "string", 2325 2325 "number": 0, 2326 - "period": 0, // Частота трансляции радиометки3669 + "period": 0, 2327 2327 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2328 2328 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2329 - "deleted": true 2330 2330 } 2331 2331 ] 2332 -}}} 2333 2333 3675 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3676 +|parentId|ID клиента 3677 +|name|Название карты-метки 3678 +|number|Номер 3679 +|period|Период запросов в секундах (работает только для агрегатов) 3680 +|id|ID карты-метки 3681 + 2334 2334 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2335 2335 2336 -GET /api/v3/Rfids/{rfidGuid} 3684 +(% class="box infomessage" %) 3685 +((( 3686 +**GET /api/v3/Rfids/{rfidGuid}** 3687 +))) 2337 2337 2338 2338 Передаем параметр rfidGuid - идентификатор карты-метки 2339 2339 2340 2340 Ответ: 2341 2341 2342 - {{{[3693 +[ 2343 2343 { 2344 2344 "name": "string", 2345 2345 "number": 0, 2346 - "period": 0, // Частота трансляции радиометки3697 + "period": 0, 2347 2347 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2348 2348 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2349 - "deleted": true 2350 2350 } 2351 2351 ] 2352 -}}} 2353 2353 3703 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3704 +|name|Название карты-метки 3705 +|number|Номер 3706 +|period|Период запросов в секундах (работает только для агрегатов) 3707 +|id|ID карты-метки 3708 +|parentId|ID клиента 3709 + 2354 2354 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2355 2355 2356 -POST /api/v3/Rfids 3712 +(% class="box successmessage" %) 3713 +((( 3714 +**POST /api/v3/Rfids** 3715 +))) 2357 2357 2358 2358 Запрос: 2359 2359 2360 -{ {{{3719 +{ 2361 2361 "name": "string", 2362 2362 "number": 0, 2363 2363 "period": 0, 2364 2364 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2365 - "deleted": true 2366 -}}}} 3724 +} 2367 2367 2368 2368 Ответ: 2369 2369 2370 -{ {{{3728 +{ 2371 2371 "name": "string", 2372 2372 "number": 0, 2373 2373 "period": 0, 2374 2374 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2375 2375 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2376 - "deleted": true 2377 2377 } 2378 -}}} 2379 2379 3736 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3737 +|name|Название карты-метки 3738 +|number|Номер 3739 +|period|Период запросов в секундах (работает только для агрегатов) 3740 +|id|ID карты-метки 3741 +|parentId|ID клиента 3742 + 2380 2380 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 2381 2381 2382 -PUT /api/v3/Rfids 3745 +(% class="box warningmessage" %) 3746 +((( 3747 +**PUT /api/v3/Rfids** 3748 +))) 2383 2383 2384 2384 Запрос: 2385 2385 2386 -{ {{{3752 +{ 2387 2387 "name": "string", 2388 2388 "number": 0, 2389 2389 "period": 0, 2390 2390 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2391 2391 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2392 - "deleted": true 2393 -}}}} 3758 +} 2394 2394 2395 2395 Ответ: 2396 2396 2397 -{ {{{3762 +{ 2398 2398 "name": "string", 2399 2399 "number": 0, 2400 2400 "period": 0, 2401 2401 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2402 2402 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2403 - "deleted": true 2404 2404 } 2405 -}}} 2406 2406 3770 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3771 +|name|Название карты-метки 3772 +|number|Номер 3773 +|period|Период запросов в секундах (работает только для агрегатов) 3774 +|id|ID карты-метки 3775 +|parentId|ID клиента 3776 + 2407 2407 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 2408 2408 2409 -DELETE /api/v3/Rfids/{rfidGuid} 3779 +(% class="box errormessage" %) 3780 +((( 3781 +**DELETE /api/v3/Rfids/{rfidGuid}** 3782 +))) 2410 2410 2411 -Передаем параметр rfidGuid - идентификатор карты-метки 3784 +Передаем параметр **rfidGuid** - идентификатор карты-метки 2412 2412 2413 2413 Ответ: 2414 2414 ... ... @@ -2415,6 +2415,2763 @@ 2415 2415 Success 2416 2416 2417 2417 3791 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3792 + 3793 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3794 + 3795 +(% class="box infomessage" %) 3796 +((( 3797 +**GET /api/v3/Billing/client/balance/{clientId}** 3798 +))) 3799 + 3800 +Параметр запроса: **clientId **- идентификатор клиента. 3801 + 3802 +Ответ: 3803 + 3804 +{ 3805 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3806 + "Balance": 0 3807 +} 3808 + 3809 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3810 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3811 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3812 + 3813 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3814 + 3815 +(% class="box infomessage" %) 3816 +((( 3817 +**GET /api/v3/Billing/client/constraint/{clientId}** 3818 +))) 3819 + 3820 +Параметр запроса: **clientId **- идентификатор клиента. 3821 + 3822 +Ответ: 3823 + 3824 +{ 3825 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3826 + "CalculationType": 0, 3827 + "PermissibleBalance": 0, 3828 + "DefermentDays": 0, 3829 + "SendUiNotifications": true, 3830 + "SendEmailNotifications": true, 3831 + "IsPrivate": true, 3832 +} 3833 + 3834 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3835 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3836 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3837 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3838 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3839 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3840 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3841 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3842 + 3843 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3844 + 3845 +(% class="box infomessage" %) 3846 +((( 3847 +**GET /api/v3/Billing/client/plan/{clientId}** 3848 +))) 3849 + 3850 +Параметры запроса: 3851 + 3852 +**clientId **- идентификатор клиента. 3853 + 3854 +**planId **- идентификатор тарифного плана. 3855 + 3856 +Ответ: 3857 + 3858 +{ 3859 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3860 + "Plan": { **~/~/ Описание тарифного плана** 3861 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3862 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3863 + "Name": "string", 3864 + "IsArchived": true, 3865 + "Constraint": { 3866 + "CalculationType": 0, 3867 + "PermissibleBalance": 0, 3868 + "DefermentDays": 0 3869 + }, 3870 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3871 + { 3872 + "Feature": "string", 3873 + "IsFactual": true, 3874 + "Limit": 0, 3875 + "Price": 0, 3876 + "PeriodValue": 0, 3877 + "PeriodType": 0 3878 + } 3879 + ] 3880 + }, 3881 + "DebitDate": "2023-10-18T12:46:24.213Z", 3882 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3883 + { 3884 + "Feature": "string", 3885 + "IsEnabled": true, 3886 + "IsPrivate": true, 3887 + "IsFactual": true, 3888 + "Limit": 0, 3889 + "Price": 0, 3890 + "DebitDate": "2023-10-18T12:46:24.213Z", 3891 + "PeriodValue": 0, 3892 + "PeriodType": 0 3893 + } 3894 + ] 3895 +} 3896 + 3897 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3898 +|ClientId|Идентификатор клиента 3899 +|Id|Идентификатор тарифного плана 3900 +|OwnerId|Идентификатор клиента-владельца 3901 +|Name|Наименование тарифного плана 3902 +|IsArchived|Признак, определяющий архивный тарифный план 3903 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3904 +|PermissibleBalance|Допустимый баланс 3905 +|DefermentDays|Отсрочка, количество дней 3906 +|Feature|Код услуги 3907 +|IsEnabled|Признак, определяющий активирована ли услуга 3908 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3909 +|IsFactual|Признак, определяющий расчёт по факту 3910 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3911 +|Price|Цена за единицу. 3912 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3913 +|PeriodValue|Значение периода. 3914 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3915 + 3916 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3917 + 3918 +(% class="box infomessage" %) 3919 +((( 3920 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3921 +))) 3922 + 3923 +Параметр запроса: **clientId **- идентификатор клиента. 3924 + 3925 +Ответ: 3926 + 3927 +[ 3928 + { 3929 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3930 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3931 + "Name": "string", 3932 + "IsArchived": true, 3933 + "Constraint": { 3934 + "CalculationType": 0, 3935 + "PermissibleBalance": 0, 3936 + "DefermentDays": 0 3937 + }, 3938 + "Features": [ 3939 + { 3940 + "Feature": "string", 3941 + "IsFactual": true, 3942 + "Limit": 0, 3943 + "Price": 0, 3944 + "PeriodValue": 0, 3945 + "PeriodType": 0 3946 + } 3947 + ] 3948 + } 3949 +] 3950 + 3951 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3952 +|ClientId|Идентификатор клиента 3953 +|Id|Идентификатор тарифного плана 3954 +|OwnerId|Идентификатор клиента-владельца 3955 +|Name|Наименование тарифного плана 3956 +|IsArchived|Признак, определяющий архивный тарифный план 3957 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3958 +|PermissibleBalance|Допустимый баланс 3959 +|DefermentDays|Отсрочка, количество дней 3960 +|Feature|Код услуги 3961 +|IsFactual|Признак, определяющий расчёт по факту 3962 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3963 +|Price|Цена за единицу. 3964 +|PeriodValue|Значение периода. 3965 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3966 + 3967 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3968 + 3969 +(% class="box infomessage" %) 3970 +((( 3971 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3972 +))) 3973 + 3974 +Параметр запроса: **clientId **- идентификатор клиента. 3975 + 3976 +Ответ: 3977 + 3978 +[ 3979 + { 3980 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3981 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3982 + "Name": "string", 3983 + "IsArchived": true, 3984 + "Constraint": { 3985 + "CalculationType": 0, 3986 + "PermissibleBalance": 0, 3987 + "DefermentDays": 0 3988 + }, 3989 + "Features": [ 3990 + { 3991 + "Feature": "string", 3992 + "IsFactual": true, 3993 + "Limit": 0, 3994 + "Price": 0, 3995 + "PeriodValue": 0, 3996 + "PeriodType": 0 3997 + } 3998 + ] 3999 + } 4000 +] 4001 + 4002 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4003 +|ClientId|Идентификатор клиента 4004 +|Id|Идентификатор тарифного плана 4005 +|OwnerId|Идентификатор клиента-владельца 4006 +|Name|Наименование тарифного плана 4007 +|IsArchived|Признак, определяющий архивный тарифный план 4008 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4009 +|PermissibleBalance|Допустимый баланс 4010 +|DefermentDays|Отсрочка, количество дней 4011 +|Feature|Код услуги 4012 +|IsFactual|Признак, определяющий расчёт по факту 4013 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4014 +|Price|Цена за единицу. 4015 +|PeriodValue|Значение периода. 4016 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4017 + 4018 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4019 + 4020 +(% class="box warningmessage" %) 4021 +((( 4022 +**PUT /api/v3/Billing/client/balance** 4023 +))) 4024 + 4025 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4026 + 4027 +Тело запроса: 4028 + 4029 +{ 4030 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4031 + "Balance": 0 ~/~/ Значение баланса. 4032 +} 4033 + 4034 +Ответ: Success 4035 + 4036 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4037 + 4038 +(% class="box warningmessage" %) 4039 +((( 4040 +**PUT /api/v3/billing/client/balance/deposit** 4041 +))) 4042 + 4043 +Создает операцию **Пополнение **с указанной суммой 4044 + 4045 +Тело запроса: 4046 + 4047 +((( 4048 +{ 4049 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4050 + "amount": 0 ~/~/ Сумма пополнения баланса 4051 +} 4052 +))) 4053 + 4054 +((( 4055 + 4056 +))) 4057 + 4058 +Ответ: Success 4059 + 4060 +((( 4061 +{ 4062 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4063 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4064 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4065 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4066 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4067 + "Description": "string" ~/~/ Описание корректировки. 4068 +} 4069 +))) 4070 + 4071 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4072 + 4073 +Создает операцию **Списание **с указанной суммой 4074 + 4075 +(% class="box warningmessage" %) 4076 +((( 4077 +**PUT /api/v3/billing/client/balance/withdraw** 4078 +))) 4079 + 4080 +Тело запроса: 4081 + 4082 +((( 4083 +{ 4084 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4085 + "amount": 0 ~/~/ Сумма списания с баланса 4086 +} 4087 +))) 4088 + 4089 +Ответ: Success 4090 + 4091 +((( 4092 +{ 4093 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4094 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4095 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4096 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4097 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4098 + "Description": "string" ~/~/ Описание корректировки 4099 +} 4100 +))) 4101 + 4102 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4103 + 4104 +(% class="box warningmessage" %) 4105 +((( 4106 +**PUT /api/v3/Billing/client/constraint** 4107 +))) 4108 + 4109 +Тело запроса: 4110 + 4111 +((( 4112 +{ 4113 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4114 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4115 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4116 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4117 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4118 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4119 +} 4120 +))) 4121 + 4122 +((( 4123 + 4124 +))) 4125 + 4126 +Ответ: Success 4127 + 4128 +((( 4129 +{ 4130 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4131 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4132 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4133 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4134 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4135 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4136 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4137 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4138 +} 4139 +))) 4140 + 4141 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4142 + 4143 +(% class="box warningmessage" %) 4144 +((( 4145 +**PUT /api/v3/Billing/client/plan** 4146 +))) 4147 + 4148 +Тело запроса: 4149 + 4150 +{ 4151 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4152 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4153 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4154 + { 4155 + "Feature": "string", ~/~/ Код услуги. 4156 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4157 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4158 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4159 + "Price": 0, ~/~/ Цена за единицу. 4160 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4161 + "PeriodValue": 0, ~/~/ Значение периода. 4162 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4163 + } 4164 + ] 4165 +} 4166 + 4167 + 4168 +Ответ: Success 4169 + 4170 +((( 4171 +{ 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4174 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4175 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4176 + "Name": "string", ~/~/ Наименование. 4177 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4178 + "Constraint": { ~/~/ Ограничения по тарифу 4179 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4180 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4181 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4182 + }, 4183 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4184 + { 4185 + "Feature": "string", ~/~/Код услуги. 4186 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4187 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4188 + "Price": 0, ~/~/ Цена за единицу. 4189 + "PeriodValue": 0, ~/~/ Значение периода. 4190 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4191 + } 4192 + ], 4193 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4194 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4195 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4196 + }, 4197 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4198 + { 4199 + "Feature": "string", ~/~/ Код услуги. 4200 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4201 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4202 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4203 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4204 + "Price": 0, ~/~/ Цена за единицу. 4205 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4206 + "PeriodValue": 0, ~/~/ Значение периода. 4207 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4208 + "Quantity": 0 ~/~/ Количество использования услуги. 4209 + } 4210 + ] 4211 +} 4212 +))) 4213 + 4214 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4215 + 4216 +(% class="box warningmessage" %) 4217 +((( 4218 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4219 +))) 4220 + 4221 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4222 + 4223 +(% class="box infomessage" %) 4224 +((( 4225 +**POST /api/v3/vehicles/import/{agentId}** 4226 +))) 4227 + 4228 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4229 + 4230 +В пути указывается **agentId** - id клиента. 4231 + 4232 +**Заголовок** 4233 + 4234 +**X-Auth: [токен авторизации]** 4235 + 4236 +**Параметры** 4237 + 4238 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4239 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4240 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4241 + 4242 +В теле использовать тип **form-data,** тип значения** file** 4243 + 4244 +**Ключи** 4245 + 4246 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4247 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4248 +|csv|В значении передаем файл датчиков, формат **csv** 4249 + 4250 +Ответ: 4251 + 4252 +{ 4253 + "vehicleId": 0, 4254 + "name": "string", 4255 + "errors": ["string"] 4256 +} 4257 + 4258 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4259 +|vehicleId|ID созданного объекта 4260 +|name|Имя созданного объекта 4261 +|errors|Ошибки и их описание 4262 + 4263 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4264 + 4265 +(% class="box infomessage" %) 4266 +((( 4267 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4268 +))) 4269 + 4270 +(% class="wikigeneratedid" %) 4271 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4272 + 4273 +(% class="wikigeneratedid" %) 4274 +В пути указывается **vehicleId **- id объекта. 4275 + 4276 +**Заголовок** 4277 + 4278 +**X-Auth: [токен авторизации]** 4279 + 4280 +В теле использовать тип **form-data.** 4281 + 4282 +Ключи: 4283 + 4284 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4285 +|**history**|В значении передавать файл с историей 4286 + 4287 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4288 + 4289 +Ответ: 4290 + 4291 +{ 4292 + "results": [ 4293 + { 4294 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4295 + "vehicleId": 0, 4296 + "errors": [ 4297 + "string" 4298 + ], 4299 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4300 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4301 + "producedCount": 0, 4302 + "msgCount": 0 4303 + } 4304 + ] 4305 +} 4306 + 4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4308 +|results|Результаты импорта в разрезе ТС 4309 +|vehicleGuid|Guid ТС 4310 +|vehicleId|ID ТС 4311 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4312 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4313 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4314 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4315 +|msgCount|Кол-во обработанных сообщений всего 4316 + 4317 +== **Импортировать историю ТС (Асинхронный запрос)** == 4318 + 4319 +(% class="box successmessage" %) 4320 +((( 4321 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4322 +))) 4323 + 4324 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4325 + 4326 +Метод запроса: **POST** 4327 + 4328 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4329 + 4330 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4331 + 4332 + 4333 +Ответ: 4334 + 4335 +{ 4336 + 4337 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4338 + 4339 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4340 + 4341 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4342 + 4343 + "Message": "string", ~/~/ Информация о выполнении запроса 4344 + 4345 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4346 + 4347 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4348 + 4349 + "Data": "string" ~/~/ Данные 4350 + 4351 +} 4352 + 4353 + 4354 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4355 + 4356 +(% class="box infomessage" %) 4357 +((( 4358 +**GET /api/v3/vehicles/import/history/status** 4359 +))) 4360 + 4361 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4362 + 4363 +Ответ: 4364 + 4365 +{ 4366 + "activity": true, 4367 + "progress": 0, 4368 + "message": "string" 4369 +} 4370 + 4371 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4372 +**Параметр** 4373 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4374 +**Описание** 4375 +))) 4376 +|((( 4377 +activity 4378 +)))|((( 4379 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4380 +))) 4381 +|((( 4382 +progress 4383 +)))|((( 4384 +Guid ТС 4385 +))) 4386 + 4387 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4388 + 4389 +(% class="box infomessage" %) 4390 +((( 4391 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4392 +))) 4393 + 4394 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4395 + 4396 +Метод запроса: **GET** 4397 + 4398 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4399 + 4400 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4401 + 4402 + 4403 +Ответ: 4404 + 4405 +{ 4406 + 4407 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4408 + 4409 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4410 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4411 + 4412 + "Message": "string", ~/~/ Информация о выполнении запроса 4413 + 4414 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4415 + 4416 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4417 + 4418 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4419 + 4420 + "Data": "string" ~/~/ Данные 4421 + 4422 +} 4423 + 4424 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4425 + 4426 +(% class="box infomessage" %) 4427 +((( 4428 +**POST /api/v3/vehicles/export** 4429 +))) 4430 + 4431 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4432 + 4433 +Тело запроса: 4434 + 4435 +[ 4436 + id 4437 +] 4438 + 4439 +Ответ: Success 200, получаете файлы с настройками. 4440 + 4441 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4442 + 4443 +(% class="box infomessage" %) 4444 +((( 4445 +**POST /api/v3/vehicles/export/history** 4446 +))) 4447 + 4448 +Метод возвращает список сообщений терминала объекта за выбранный период. 4449 + 4450 +Тело запроса: 4451 + 4452 +{ 4453 + "vehicleId": 0, 4454 + "asArchive": true, 4455 + "from": "2023-09-27T12:17:45.973Z", 4456 + "to": "2023-09-27T12:17:45.973Z" 4457 +} 4458 + 4459 +Ответ: 4460 + 4461 +Получаете файл. Сообщение: Code 200/Success 4462 + 4463 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4464 +|vehicleId|ID объекта 4465 +|asArchive|true - Архивировать файл, False - не архивировать 4466 +|from|Дата и время начала запроса 4467 +|to|Дата и время окончания запроса 4468 + 4469 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4470 + 4471 +(% class="box infomessage" %) 4472 +((( 4473 +**GET /api/v3/vehicles/export/history/status** 4474 +))) 4475 + 4476 +Метод возвращает список сообщений терминала объекта за выбранный период. 4477 + 4478 +Ответ: 4479 + 4480 +{ 4481 + "activity": true, 4482 + "progress": 0, 4483 + "message": "string" 4484 +} 4485 + 4486 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4487 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4488 +|progress|Прогресс экспорта, от 0 до 100% 4489 +|message|Текст описывающий статус 4490 + 4491 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4492 + 4493 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4494 + 4495 +(% class="box infomessage" %) 4496 +((( 4497 +**POST /api/v3/EcoDriving/rating** 4498 +))) 4499 + 4500 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4501 + 4502 +Тело запроса: 4503 + 4504 +{ 4505 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4506 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4507 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4508 +} 4509 + 4510 +Ответ: 4511 + 4512 +{ 4513 + "items": [ ~/~/ Список в разрезе ТС 4514 + { 4515 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4516 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4517 + "vehicleId": 0, ~/~/ ID ТС 4518 + "vehicleName": "string", ~/~/ Название ТС 4519 + "vehicleModel": "string", ~/~/ Модель ТС 4520 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4521 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4522 + "totalViolations": 0, ~/~/ Нарушений всего 4523 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4524 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4525 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4526 + "brakingViolations": 0, ~/~/ Нарушений торможения 4527 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4528 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4529 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4530 + }, 4531 + 4532 +((( 4533 + 4534 +))) 4535 + 4536 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4537 + "mileage": 0, ~/~/ Пробег, м 4538 + "tripsCount": 0, ~/~/ Кол-во рейсов 4539 + "trips": [ ~/~/ Информация по рейсу 4540 + { 4541 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4542 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4543 + "violationsCount": 0, ~/~/ Всего нарушений 4544 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4545 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4546 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4547 + "brakingViolations": 0, ~/~/ Нарушений торможения 4548 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4549 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4550 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4551 + }, 4552 + 4553 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4554 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4555 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4556 + "mileage": 0, ~/~/ Пробег, м 4557 + "motohours": 0, ~/~/ Моточасы, секунды 4558 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4559 + "startAddress": "string", ~/~/ Адрес начала рейса 4560 + "endAddress": "string", ~/~/ Адрес конца рейса 4561 + "drivers": [ ~/~/ Список водителей 4562 + { 4563 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4564 + "driverName": "string", ~/~/ФИО водителя 4565 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4566 + } 4567 + ] 4568 + } 4569 + ] 4570 + } 4571 + ] 4572 +} 4573 + 4574 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4575 + 4576 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4577 + 4578 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4579 + 4580 +(% class="box infomessage" %) 4581 +((( 4582 +**POST /api/v3/fuelcards/transactions** 4583 +))) 4584 + 4585 +Метод запроса: POST 4586 + 4587 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4588 +\\В заголовках запроса: X-Auth: Токен авторизации 4589 + 4590 +Параметры в теле запроса (JSON): 4591 + 4592 +{ 4593 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4594 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4595 + "ids": [ 4596 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4597 + ], 4598 + "timezone": 0 ~/~/ Часовой пояс 4599 +} 4600 + 4601 + 4602 +Ответ: 4603 + { 4604 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4605 + "driver": "string", ~/~/ Водители, привязанные к ТК 4606 + "object": "string", ~/~/ Наименование ТС 4607 + "amount": 0, ~/~/ Количество топлива 4608 + "amountDut": 0, ~/~/ Количество по ДУТ 4609 + "amountDiff": 0, ~/~/ Разница, л 4610 + "amountDiffPerc": 0, ~/~/ Разница, % 4611 + "summa": 0, ~/~/ Стоимость, руб 4612 + "serviceName": "string", ~/~/ Тип топлива 4613 + "price": 0, ~/~/ Цена за литр, руб 4614 + "cardName": "string", ~/~/ Наименование ТК 4615 + "cardNum": "string", ~/~/ Номер ТК 4616 + "operator": "string", ~/~/ Оператор ТК 4617 + "address": "string" ~/~/ Адрес АЗС 4618 + } 4619 + 4620 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4621 + 4622 +(% class="box infomessage" %) 4623 +((( 4624 +**GET /api/v3/fuelcards** 4625 +))) 4626 + 4627 +Метод запроса: GET 4628 + 4629 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4630 + 4631 +Ответ: 4632 + 4633 +[ 4634 + { 4635 + "Name": "string", ~/~/ Определяет наименование карты. 4636 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4637 + "Number": "string", ~/~/ Определяет № карты. 4638 + "Enabled": true, ~/~/ Определяет признак активности карты. 4639 + "Description": "string", ~/~/ Определяет описание карты. 4640 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4641 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4642 + "deleted": true ~/~/ Признак удаления 4643 + } 4644 +] 4645 + 4646 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4647 + 4648 + 4649 +== **Получение полных данных о ретрансляторе** == 4650 + 4651 +(% class="box infomessage" %) 4652 +((( 4653 +**GET ** **/api/v3/retranslations/{id}** 4654 +))) 4655 + 4656 +id - Идентификатор ретранслятора 4657 + 4658 + 4659 +Пример ответа: 4660 + 4661 +{ 4662 +"description": "", ~/~/ Поле описания ретранслятора 4663 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4664 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4665 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4666 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4667 +"objects": [ ~/~/ Объекты для ретрансляции 4668 +{ 4669 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4670 +"name": "", ~/~/ Наименование объекта ретрансляции 4671 +"imei": "", ~/~/ IMEI объекта ретрансляции 4672 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4673 +} 4674 + ], 4675 +"id": "", ~/~/ Идентификатор ретранслятора 4676 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4677 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4678 +} 4679 + 4680 + 4681 +== **Удаление данных ретранслятора** == 4682 + 4683 +(% class="box infomessage" %) 4684 +((( 4685 +**DELETE** **/api/v3/retranslations/{id}** 4686 +))) 4687 + 4688 +id - Идентификатор ретранслятора 4689 + 4690 + 4691 +== **Создание ретранслятора** == 4692 + 4693 +(% class="box infomessage" %) 4694 +((( 4695 +**POST ** **/api/v3/retranslations/{id}** 4696 +))) 4697 + 4698 +Запрос: 4699 + 4700 +{ 4701 +"description": "", ~/~/ Поле описания ретранслятора 4702 +"subscriberId": "", ~/~/ Идентификатор подписчика 4703 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4704 +"address": "", ~/~/ Адрес и порт принимающего сервера 4705 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4706 +"objects": [ ~/~/Объекты для ретрансляции 4707 +{ 4708 +"id": "", ~/~/ Идентификатор ретранслятора 4709 +"imei": "", ~/~/ IMEI объекта ретрансляции 4710 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4711 +} 4712 + ] 4713 +} 4714 + 4715 + 4716 +Ответ: 4717 + 4718 +{ 4719 +"description": "", ~/~/ Поле описания ретранслятора 4720 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4721 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4722 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4723 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4724 +"objects": [ ~/~/ Объекты для ретрансляции 4725 +{ 4726 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4727 +"name": "string", ~/~/ Наименование объекта ретрансляции 4728 +"imei": "", ~/~/ IMEI объекта ретрансляции 4729 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4730 +} 4731 + ], 4732 +"id": "", ~/~/ Идентификатор ретранслятора 4733 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4734 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4735 +} 4736 + 4737 + 4738 +== **Редактирование ретранслятора** == 4739 + 4740 +(% class="box infomessage" %) 4741 +((( 4742 +**PUT** **/api/v3/retranslations** 4743 +))) 4744 + 4745 +Пример запроса: 4746 + 4747 +{ 4748 +"id": "", ~/~/ Идентификатор ретранслятора 4749 +"description": "string", ~/~/ Поле описания ретранслятора 4750 +"subscriberId": "", ~/~/ Идентификатор подписчика 4751 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4752 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4753 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4754 +"objects": ~/~/ Объекты для ретрансляции 4755 +[ 4756 +{ 4757 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4758 +"imei": "", ~/~/ IMEI объекта ретрансляции 4759 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4760 +} 4761 + ] 4762 +} 4763 + 4764 + 4765 +Пример ответа: 4766 + 4767 +{ 4768 +"description": "", ~/~/ Поле описания ретранслятора 4769 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4770 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4771 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4772 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4773 +"objects": [ ~/~/ Объекты для ретрансляции 4774 +{ 4775 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4776 +"name": "string", ~/~/ Наименование объекта ретрансляции 4777 +"imei": "", ~/~/ IMEI объекта ретрансляции 4778 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4779 +} 4780 + ], 4781 +"id": "", ~/~/ Идентификатор ретранслятора 4782 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4783 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4784 +} 4785 + 4786 + 4787 +== **Получение списка ретранслятора клиента** == 4788 + 4789 +(% class="box infomessage" %) 4790 +((( 4791 +**POST /api/v3/retranslations/find** 4792 +))) 4793 + 4794 +Пример запроса: 4795 + 4796 +{ 4797 +"id": "", ~/~/ Идентификатор ретранслятора 4798 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4799 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4800 +} 4801 + 4802 +Ответ: 4803 + 4804 +[ 4805 +{ 4806 +"description": "", ~/~/ Поле описания ретранслятора 4807 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4808 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4809 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4810 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4811 +"id": "", ~/~/ Идентификатор ретранслятора 4812 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4813 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4814 +} 4815 +] 4816 + 4817 + 4818 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4819 + 4820 +== **API для отчета по выгрузке комбайнов** == 4821 + 4822 +(% class="box infomessage" %) 4823 +((( 4824 +**POST /api/v3/Reports/harvesterUnloading** 4825 +))) 4826 + 4827 +Пример запроса: 4828 + 4829 +{ 4830 + "byTime": 0, ~/~/ Объединение событий по времени 4831 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4832 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4833 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4834 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4835 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4836 + 0 4837 + ], 4838 + "from": "", ~/~/ Дата и время начало запроса 4839 + "to": "", ~/~/ Дата и время окончания запроса 4840 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4841 +} 4842 + 4843 +Пример ответа: 4844 + 4845 +[ 4846 + { 4847 + "harvesterName": "", ~/~/Комбайн, номер 4848 + "harvesterId": 0, ~/~/Комбайн, id 4849 +"harvesterModel": "", ~/~/ Модель комбайна 4850 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4851 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4852 + "events": [ ~/~/Список событий в разрезе комбайна 4853 + { 4854 + "driverId": "", ~/~/Идентификатор водителя 4855 + "driverName": "", ~/~/Водитель комбайна, ФИО 4856 + "RFID": "", ~/~/ идентификатор карты-метки 4857 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4858 + "vehicleId": 0, ~/~/идентификатор объекта 4859 + "vehicleName": "string", ~/~/ Имя объекта 4860 + "modelName": "string", ~/~/ Имя модели объекта 4861 + "nearestVehicles": [ ~/~/Объекты рядом 4862 + { 4863 + "vehicleId": 0, ~/~/идентификатор объекта 4864 + "vehicleName": "string" ~/~/ Имя объекта 4865 + } 4866 + ], 4867 + "fields": [ ~/~/Поля, где происходила выгрузка 4868 + { 4869 + "id": 0, ~/~/ идентификатор пользователя 4870 + "name": "string" ~/~/ имя пользователя 4871 + } 4872 + ], 4873 + "event": "string", ~/~/Событие 4874 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4875 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4876 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4877 + "cultureName": "string", ~/~/ название культуры 4878 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4879 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4880 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4881 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4882 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4883 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4884 + "issued": 0, ~/~/Выдано, бункеров 4885 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4886 + "latitude": 0, ~/~/Широта 4887 + "longitude": 0, ~/~/ Долгота 4888 + "litresAway": 0, ~/~/Отдано, л 4889 + "m3Away": 0 ~/~/Отдано, м3 4890 + } 4891 + ] 4892 + } 4893 +] 4894 + 4895 + 4896 +== **Отчет трек-датчики** == 4897 + 4898 +(% class="box infomessage" %) 4899 +((( 4900 +**POST /api/v3/Reports/sensorsWorks** 4901 +))) 4902 + 4903 +**Пример запроса:** 4904 + 4905 +{ 4906 + "vehicleIds": [ ~/~/ Список ID объектов 4907 + 0 4908 + ], 4909 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4910 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4911 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4912 +} 4913 + 4914 +**Пример ответа:** 4915 + 4916 +((( 4917 +{ 4918 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4919 + { 4920 + "vehicleId": 0, ~/~/ Идентификатор ТС 4921 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4922 + { 4923 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4924 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4925 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4926 + "name": "string", ~/~/ Наименование оборудования. 4927 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4928 + "totalMileage": 0, ~/~/ Общий пробег. 4929 + "avgSpeed": 0 ~/~/ Средняя скорость. 4930 + } 4931 + ] 4932 + } 4933 + ] 4934 +} 4935 + 4936 + 4937 +== **Превышение скорости** == 4938 + 4939 +(% class="box infomessage" %) 4940 +((( 4941 +**POST /api/v3/Reports/overSpeedDuration** 4942 +))) 4943 + 4944 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4945 + 4946 +Пример запроса: 4947 + 4948 +((( 4949 +{ 4950 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4951 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4952 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4953 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4954 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4955 +} 4956 +))) 4957 + 4958 +((( 4959 + 4960 +))) 4961 + 4962 +((( 4963 +Пример ответа: 4964 +))) 4965 + 4966 +((( 4967 +((( 4968 +[ 4969 + { 4970 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4971 + "duration": 0, ~/~/ Продолжительность события в секундах 4972 + "maxSpeed": 0, ~/~/ Максимальная скорость 4973 + "speedLimit": 0 ~/~/ Ограничение скорости 4974 + } 4975 +] 4976 +))) 4977 +))) 4978 +))) 4979 + 4980 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4981 + 4982 + 4983 +== **Запрос списка полей** == 4984 + 4985 +(% class="box successmessage" %) 4986 +((( 4987 +**POST /api/v3/agroLands/find** 4988 +))) 4989 + 4990 +Пример запроса: 4991 + 4992 +((( 4993 +((( 4994 +((( 4995 +{ 4996 + "year": 0, ~/~/ Фильтр по году 4997 + "name": "string", ~/~/ Фильтр по названию 4998 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4999 +} 5000 +))) 5001 +))) 5002 + 5003 + 5004 +))) 5005 + 5006 +Пример ответа: 5007 + 5008 +((( 5009 +[ 5010 + { 5011 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5012 + "year": 0, ~/~/ Год поля 5013 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5014 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5015 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5016 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5017 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5018 + "counts": { ~/~/ Счётчики с/х поля 5019 + "fieldOperations": 0, ~/~/ Количество операций на поле 5020 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5021 + "facts": 0 ~/~/ Счётчик факта 5022 + }, 5023 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5024 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5025 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5026 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5027 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5028 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5029 + "planComment": "string", ~/~/ Комментарий к полю 5030 + "productivity": 0, ~/~/ Урожайность. 5031 + "id": 0, ~/~/ Идентификатор объекта геозоны 5032 + "name": "string", ~/~/ Название объекта геозоны 5033 + "type": 0, ~/~/ Тип объекта геозоны 5034 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5035 + "fname": "string", ~/~/ Имя файла 5036 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5037 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5038 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5039 + "description": "string", ~/~/ Описание объекта геозоны 5040 + "area": 0, ~/~/ Площадь, м2 5041 + "perimetr": 0, ~/~/ Периметр, м 5042 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5043 + } 5044 +] 5045 + 5046 + 5047 +== **Создание нового поля ** == 5048 + 5049 +(% class="box successmessage" %) 5050 +((( 5051 +**POST /api/v3/agroLands** 5052 +))) 5053 + 5054 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5055 +X-agent - ID клиента 5056 + 5057 +Пример запроса: 5058 + 5059 +((( 5060 +{ 5061 + "extId": "string", 5062 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5063 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5064 + "display": "string", ~/~/ Настройки отображения 5065 + "year": 0, ~/~/ Год поля 5066 + "name": "string", ~/~/ Наименование 5067 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5068 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5069 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5070 + "planComment": "string", ~/~/ Комментарий к полю 5071 + "cropRotations": [ ~/~/ Данные по севообороту 5072 + { 5073 + "landId": 0, ~/~/ ID поля 5074 + "landName": "string", ~/~/ Название поля 5075 + "year": 0, ~/~/ Год урожая 5076 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5077 + "cultureName": "string", ~/~/ Название культуры 5078 + "productivity": 0, ~/~/ Урожайность 5079 + "area": 0, ~/~/ Площадь поля, Га 5080 + "total": 0, ~/~/ Валовый сбор 5081 + "productivityFact": 0, ~/~/ Фактическая урожайность 5082 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5083 + "totalFact": 0, ~/~/ Фактический валовый сбор 5084 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5085 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5086 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5087 + "isyearplan": true, ~/~/ Годовой план 5088 + "comment": "string" ~/~/ Комментарий 5089 + } 5090 + ] 5091 +} 5092 +))) 5093 + 5094 +((( 5095 + 5096 +))) 5097 + 5098 +Пример ответа: 5099 + 5100 +((( 5101 +((( 5102 +{ 5103 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5104 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5105 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5106 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5107 + "cropRotations": [ ~/~/ Данные по севообороту 5108 + { 5109 + "landId": 0, ~/~/ ID поля 5110 + "landName": "string", ~/~/ Название поля 5111 + "year": 0, ~/~/ Год урожая 5112 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5113 + "cultureName": "string", ~/~/ Название культуры 5114 + "productivity": 0, ~/~/ Урожайность 5115 + "area": 0, ~/~/ Площадь поля, Га. 5116 + "total": 0, ~/~/ Валовый сбор 5117 + "productivityFact": 0, ~/~/ Фактическая урожайность 5118 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5119 + "totalFact": 0, ~/~/ Фактический валовый сбор 5120 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5121 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5122 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5123 + "isyearplan": true, ~/~/ годовой план 5124 + "comment": "string" ~/~/ Комментарий 5125 + } 5126 + ], 5127 + "cropVegetation": [ ~/~/ История вегетации поля 5128 + { 5129 + "values": [ ~/~/ Данные вегетации и состояния посева 5130 + { 5131 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5132 + "ndvi": 0 ~/~/ Индекс вегетации 5133 + } 5134 + ], 5135 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5136 + { 5137 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5138 + "type": "string", ~/~/ Тип 5139 + "pictureid": "string" ~/~/ Идентификатор ресурса 5140 + } 5141 + ], 5142 + "states": [ ~/~/ Ключевые даты развития поля 5143 + { 5144 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5145 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5146 + } 5147 + ] 5148 + } 5149 + ], 5150 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5151 + "counts": { 5152 + "fieldOperations": 0, ~/~/ Количество операций на поле 5153 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5154 + "facts": 0 ~/~/ Счётчик факта 5155 + }, 5156 + "planComment": "string", ~/~/ Комментарий к полю 5157 +))) 5158 + 5159 +((( 5160 + "productivity": 0, ~/~/ Урожайность. 5161 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5162 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5163 + "year": 0, ~/~/ Год поля 5164 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5165 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5166 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5167 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5168 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5169 + "id": 0, ~/~/ Идентификатор объекта геозоны 5170 + "name": "string", ~/~/ Название объекта геозоны 5171 + "type": 0, ~/~/ Тип объекта геозоны 5172 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5173 + "fname": "string", ~/~/ Имя файла 5174 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5175 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5176 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5177 + "description": "string", ~/~/ Описание объекта геозоны 5178 + "area": 0, ~/~/ Площадь, м2 5179 + "perimetr": 0, ~/~/ Периметр, м 5180 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5181 +} 5182 + 5183 + 5184 +))) 5185 +))) 5186 +))) 5187 + 5188 +== **Получение поля по id** == 5189 + 5190 +(% class="box infomessage" %) 5191 +((( 5192 +**GET /api/v3/agroLands/{id}** 5193 +))) 5194 + 5195 +Пример запроса: 5196 +id ~/~/ Идентификатор поля 5197 + 5198 +Пример ответа: 5199 + 5200 +((( 5201 +{ 5202 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5203 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5204 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5205 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5206 + "cropRotations": [ ~/~/ Данные по севообороту 5207 + { 5208 + "landId": 0, ~/~/ ID поля 5209 + "landName": "string", ~/~/ Название поля 5210 + "year": 0, ~/~/ Год урожая 5211 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5212 + "cultureName": "string", ~/~/ Название культуры 5213 + "productivity": 0, ~/~/ Урожайность 5214 + "area": 0, ~/~/ Площадь поля, Га 5215 + "total": 0, ~/~/ Валовый сбор 5216 + "productivityFact": 0, ~/~/ Фактическая урожайность 5217 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5218 + "totalFact": 0, ~/~/ Фактический валовый сбор 5219 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5220 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5221 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5222 + "isyearplan": true, ~/~/ План года 5223 + "comment": "string" ~/~/ Комментарий 5224 + } 5225 + ], 5226 + "cropVegetation": [ ~/~/ История вегетации поля 5227 + { 5228 + "values": [ ~/~/ Данные вегетации и состояния посева 5229 + { 5230 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5231 + "ndvi": 0 ~/~/ Индекс вегетации 5232 + } 5233 + ], 5234 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5235 + { 5236 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5237 + "type": "string", ~/~/ Тип 5238 + "pictureid": "string" ~/~/ Идентификатор ресурса 5239 + } 5240 + ], 5241 + "states": [ ~/~/ Ключевые даты развития поля 5242 + { 5243 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5244 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5245 + } 5246 + ] 5247 + } 5248 + ], 5249 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5250 + "counts": { 5251 + "fieldOperations": 0, ~/~/ Количество операций на поле 5252 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5253 + "facts": 0 ~/~/ Счётчик факта 5254 + }, 5255 + "planComment": "string", ~/~/ Комментарий к полю 5256 + "productivity": 0, ~/~/ Урожайность. 5257 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5258 +))) 5259 + 5260 +((( 5261 +((( 5262 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5263 + "year": 0, ~/~/ Год поля 5264 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5265 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5266 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5267 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5268 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5269 + "id": 0, ~/~/ Идентификатор объекта геозоны 5270 + "name": "string", ~/~/ Название объекта геозоны 5271 + "type": 0, ~/~/ Тип объекта геозоны 5272 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5273 + "fname": "string", ~/~/ Имя файла 5274 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5275 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5276 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5277 + "description": "string", ~/~/ Описание объекта геозоны 5278 + "area": 0, ~/~/ Площадь, м2 5279 + "perimetr": 0, ~/~/ Периметр, м 5280 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5281 +} 5282 +))) 5283 + 5284 + 5285 +((( 5286 +((( 5287 +((( 5288 +== **Изменение поля** == 5289 + 5290 +(% class="box infomessage" %) 5291 +((( 5292 +**PUT /api/v3/agroLands** 5293 +))) 5294 + 5295 +Пример запроса: 5296 + 5297 +((( 5298 +((( 5299 +{ 5300 + "id": 0, ~/~/ Идентификатор поля 5301 + "extId": "string", ~/~/ ExtId 5302 + "shape": "string", ~/~/ Форма поля 5303 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5304 + "display": "string", ~/~/ Настройки отображения 5305 + "year": 0, ~/~/ Год поля 5306 + "name": "string", ~/~/ Наименование 5307 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5308 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5309 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5310 + "planComment": "string", ~/~/Комментарий к полю 5311 + "cropRotations": [ ~/~/ Данные по севообороту 5312 + { 5313 + "landId": 0, ~/~/ ID поля 5314 + "landName": "string", ~/~/ Название поля 5315 + "year": 0, ~/~/ Год урожая 5316 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5317 + "cultureName": "string", ~/~/ Название культуры 5318 + "productivity": 0, ~/~/ Урожайность 5319 + "area": 0, ~/~/ Площадь поля, Га. 5320 + "total": 0, ~/~/ Валовый сбор 5321 + "productivityFact": 0, ~/~/ Фактическая урожайность 5322 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5323 + "totalFact": 0, ~/~/ Фактический валовый сбор 5324 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5325 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5326 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5327 + "isyearplan": true, 5328 + "comment": "string" ~/~/ Комментарий 5329 + } 5330 + ], 5331 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5332 +} 5333 +))) 5334 +))) 5335 + 5336 +((( 5337 + 5338 +))) 5339 + 5340 +Пример ответа: 5341 + 5342 +((( 5343 +((( 5344 +((( 5345 +{ 5346 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5347 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5348 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5349 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5350 + "cropRotations": [ ~/~/ Данные по севообороту 5351 + { 5352 + "landId": 0, ~/~/ ID поля 5353 + "landName": "string", ~/~/ Название поля 5354 + "year": 0, ~/~/ Год урожая 5355 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5356 + "cultureName": "string", ~/~/ Название культуры 5357 + "productivity": 0, ~/~/ Урожайность 5358 + "area": 0, ~/~/ Площадь поля, Га 5359 + "total": 0, ~/~/ Валовый сбор 5360 + "productivityFact": 0, ~/~/ Фактическая урожайность 5361 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5362 + "totalFact": 0, ~/~/ Фактический валовый сбор 5363 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5364 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5365 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5366 + "isyearplan": true, ~/~/ 5367 + "comment": "string" ~/~/ Комментарий 5368 + } 5369 + ], 5370 + "cropVegetation": [ ~/~/ История вегетации поля 5371 + { 5372 + "values": [ ~/~/ Данные вегетации и состояния посева 5373 + { 5374 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5375 + "ndvi": 0 ~/~/ Индекс вегетации 5376 + } 5377 + ], 5378 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5379 + { 5380 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5381 + "type": "string", ~/~/ Тип 5382 + "pictureid": "string" ~/~/ Идентификатор ресурса 5383 + } 5384 + ], 5385 + "states": [ ~/~/ Ключевые даты развития поля 5386 + { 5387 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5388 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5389 + } 5390 + ] 5391 + } 5392 + ], 5393 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5394 + "counts": { 5395 + "fieldOperations": 0, ~/~/ Количество операций на поле 5396 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5397 + "facts": 0 ~/~/ Счётчик факта 5398 + }, 5399 + "planComment": "string", ~/~/ Комментарий к полю 5400 + "productivity": 0, ~/~/ Урожайность. 5401 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5402 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5403 + "year": 0, ~/~/ Год поля 5404 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5405 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5406 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5407 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5408 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5409 + "id": 0, ~/~/ Идентификатор объекта геозоны 5410 + "name": "string", ~/~/ Название объекта геозоны 5411 + "type": 0, ~/~/ Тип объекта геозоны 5412 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5413 + "fname": "string", ~/~/ Имя файла 5414 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5415 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5416 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5417 + "description": "string", ~/~/ Описание объекта геозоны 5418 + "area": 0, ~/~/ Площадь, м2 5419 + "perimetr": 0, ~/~/ Периметр, м 5420 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5421 +} 5422 +))) 5423 +))) 5424 +))) 5425 +))) 5426 +))) 5427 + 5428 + 5429 +== **Редактирование года урожая ** == 5430 + 5431 +(% class="box successmessage" %) 5432 +((( 5433 +**POST /api/v3/agroLands/updateOpenCloseYear** 5434 +))) 5435 + 5436 +Пример запроса: 5437 + 5438 +((( 5439 +((( 5440 +{ 5441 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5442 + 0 5443 + ], 5444 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5445 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5446 +} 5447 +))) 5448 + 5449 + 5450 +))) 5451 + 5452 +Пример ответа: 5453 + 5454 +((( 5455 +((( 5456 +{ 5457 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5458 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5459 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5460 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5461 + "cropRotations": [ ~/~/ Данные по севообороту 5462 + { 5463 + "landId": 0, ~/~/ ID поля 5464 + "landName": "string", ~/~/ Название поля 5465 + "year": 0, ~/~/ Год урожая 5466 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5467 + "cultureName": "string", ~/~/ Название культуры 5468 + "productivity": 0, ~/~/ Урожайность 5469 + "area": 0, ~/~/ Площадь поля, Га. 5470 + "total": 0, ~/~/ Валовый сбор 5471 + "productivityFact": 0, ~/~/ Фактическая урожайность 5472 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5473 + "totalFact": 0, ~/~/ Фактический валовый сбор 5474 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5475 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5476 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5477 + "isyearplan": true, ~/~/ 5478 + "comment": "string" ~/~/ Комментарий 5479 + } 5480 + ], 5481 + "cropVegetation": [ ~/~/ История вегетации поля 5482 + { 5483 + "values": [ ~/~/ Данные вегетации и состояния посева 5484 + { 5485 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5486 + "ndvi": 0 ~/~/ Индекс вегетации 5487 + } 5488 + ], 5489 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5490 + { 5491 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5492 + "type": "string", ~/~/ Тип 5493 + "pictureid": "string" ~/~/ Идентификатор ресурса 5494 + } 5495 + ], 5496 + "states": [ ~/~/ Ключевые даты развития поля 5497 + { 5498 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5499 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5500 + } 5501 + ] 5502 + } 5503 + ], 5504 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5505 + "counts": { 5506 + "fieldOperations": 0, ~/~/ Количество операций на поле 5507 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5508 + "facts": 0 ~/~/ Счётчик факта 5509 + }, 5510 + "planComment": "string", ~/~/ Комментарий к полю 5511 + "productivity": 0, ~/~/ Урожайность. 5512 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5513 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5514 + "year": 0, ~/~/ Год поля 5515 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5516 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5517 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5518 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5519 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5520 + "id": 0, ~/~/ Идентификатор объекта геозоны 5521 + "name": "string", ~/~/ Название объекта геозоны 5522 + "type": 0, ~/~/ Тип объекта геозоны 5523 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5524 + "fname": "string", ~/~/ Имя файла 5525 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5526 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5527 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5528 + "description": "string", ~/~/ Описание объекта геозоны 5529 + "area": 0, ~/~/ Площадь, м2 5530 + "perimetr": 0, ~/~/ ериметр, м 5531 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5532 +} 5533 + 5534 + 5535 +== **Какие поля посещал объект** == 5536 + 5537 +(% class="box successmessage" %) 5538 +((( 5539 +**POST /api/v3/agroLands/visitingByVehicle** 5540 +))) 5541 + 5542 +Пример запроса: 5543 + 5544 +{ 5545 + "vehicleId": 0, ~/~/ id объекта 5546 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5547 + "byTime": 0, ~/~/ Объединение событий по времени 5548 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5549 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5550 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5551 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5552 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5553 +} 5554 + 5555 +Пример ответа: 5556 + 5557 +[ 5558 + { 5559 + "fieldId": 0, ~/~/ id объекта 5560 + "vehicleName": "string", ~/~/ Наименование объекта 5561 + "fieldName": "string", ~/~/ Наименование поля 5562 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5563 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5564 + "vehicleId": 0, ~/~/ Идентификатор ТС 5565 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5566 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5567 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5568 + "mileage": 0 ~/~/ Пробег 5569 + } 5570 +] 5571 +))) 5572 + 5573 + 5574 +== **Посещение поля объектами ** == 5575 + 5576 +(% class="box successmessage" %) 5577 +((( 5578 +**POST /api/v3/agroLands/visitingByField** 5579 +))) 5580 + 5581 +Пример запроса: 5582 +{ 5583 + "fieldId": 0, ~/~/ ID поля 5584 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5585 + "byTime": 0, ~/~/ Объединение событий по времени 5586 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5587 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5588 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5589 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5590 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5591 +} 5592 + 5593 +Пример ответа: 5594 + 5595 +[ 5596 + { 5597 + "fieldId": 0, ~/~/ ID поля 5598 + "vehicleName": "string", ~/~/ Наименование объекта 5599 + "fieldName": "string", ~/~/ Имя поля 5600 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5601 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5602 + "vehicleId": 0, ~/~/ Идентификатор ТС 5603 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5604 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5605 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5606 + "mileage": 0 ~/~/ Пробег 5607 + } 5608 +] 5609 + 5610 + 5611 +== **Удаление существующего поля** == 5612 + 5613 +(% class="box errormessage" %) 5614 +((( 5615 +**DELETE /api/v3/agroLands/{id}** 5616 +))) 5617 + 5618 +Пример запроса: 5619 +id ~/~/ Идентификатор поля 5620 + 5621 +Пример ответа: 5622 + 5623 +((( 5624 +200 ~/~/ Успех 5625 + 5626 + 5627 +))) 5628 + 5629 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5630 +))) 5631 +))) 5632 +))) 5633 + 5634 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5635 + 5636 + 5637 +(% class="box infomessage" %) 5638 +((( 5639 +**GET api/v3/Vehicles/recyclebin/all** 5640 +))) 5641 + 5642 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5643 + 5644 +Параметр запроса: {parentId} - идентификатор агента 5645 + 5646 +В заголовках запроса: X-Auth: Токен авторизации 5647 + 5648 +Ответ: 5649 + 5650 +[ 5651 + { 5652 + "recordTime": "", ~/~/Время записи 5653 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5654 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5655 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5656 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5657 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5658 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5659 + "items": [ ~/~/ 5660 +nullable: true ~/~/Детали 5661 + { 5662 + "name": "string", ~/~/наименование столбца 5663 + "value": "string" ~/~/содержание столбца 5664 + } 5665 + ] 5666 + }, 5667 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5668 + "string" 5669 + ] 5670 + } 5671 +] 5672 + 5673 + 5674 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5675 + 5676 +(% class="box infomessage" %) 5677 +((( 5678 +**POST api/v3/Vehicles/recyclebin/erase** 5679 +))) 5680 + 5681 +В заголовках запроса: X-Auth: Токен авторизации 5682 + 5683 +Пример запроса: 5684 + 5685 +[ 5686 +0 5687 +] 5688 + 5689 + 5690 +Пример ответа: 5691 + 5692 +[ 5693 +{ 5694 + "recordTime": "", ~/~/Время записи 5695 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5696 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5697 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5698 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5699 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5700 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5701 + "items": [ ~/~/Детали 5702 + { 5703 + "name": "", ~/~/Имя свойства 5704 + "value": "" ~/~/Значение свойства 5705 + } 5706 + ] 5707 + }, 5708 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5709 + "" 5710 + ] 5711 + } 5712 +] 5713 + 5714 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5715 + 5716 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5717 + 5718 +(% class="box infomessage" %) 5719 +((( 5720 +**POST api/v3/Vehicles/recyclebin/restore** 5721 +))) 5722 + 5723 +В заголовках запроса: X-Auth: Токен авторизации 5724 + 5725 +Параметры в теле запроса (JSON): 5726 + 5727 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5728 + 5729 +В заголовках запроса: X-Auth: Токен авторизации 5730 + 5731 + 5732 +Пример запроса: 5733 + 5734 +((( 5735 +[ 5736 +))) 5737 + 5738 +((( 5739 + 0 5740 +))) 5741 + 5742 +((( 5743 +] 5744 +))) 5745 + 5746 + 5747 +Пример ответа: 5748 + 5749 +[ 5750 +{ 5751 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5752 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5753 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5754 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5755 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5756 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5757 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5758 + "items": [ ~/~/Детали 5759 + { 5760 + "name": "string", ~/~/Имя свойства 5761 + "value": "string" ~/~/Значение свойства 5762 + } 5763 + ] 5764 + }, 5765 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5766 + "string" 5767 + ] 5768 + } 5769 +] 5770 + 5771 + 5772 += **Раздел: Журнал заданий ** = 5773 + 5774 + 5775 +== **Создание задания в Журнале заданий** == 5776 + 5777 +(% class="box infomessage" %) 5778 +((( 5779 +**POST /api/v3/vehicletasks** 5780 +))) 5781 + 5782 +Пример запроса: 5783 + 5784 +((( 5785 +{ 5786 + "vehicleId": 0, ~/~/ Идентификатор ТС 5787 + "description": "string", ~/~/ Описание 5788 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5789 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5790 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5791 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5792 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5793 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5794 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5795 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5796 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5797 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5798 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5799 + "cost": { 5800 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5801 + "Name": "string", ~/~/ Наименование 5802 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5803 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5804 + "Norm": 0 ~/~/ Норма внесения 5805 + }, 5806 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5807 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5808 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5809 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5810 + "deleted": true, ~/~/ Признак удаления 5811 + "extId": "string", 5812 + "GeoIds": [ ~/~/ Cвязанные поля 5813 + 0 5814 + ] 5815 +} 5816 +))) 5817 + 5818 + 5819 +Пример ответа: 5820 + 5821 +{ 5822 + "vehicleId": 0, ~/~/ Идентификатор ТС 5823 + "description": "string", ~/~/ Описание 5824 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5825 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5826 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5827 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5828 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5829 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5830 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5831 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5832 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5833 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5834 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5835 + "cost": { 5836 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5837 + "Name": "string", ~/~/ Наименование 5838 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5839 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5840 + "Norm": 0 ~/~/ Норма внесения 5841 + }, 5842 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5843 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5844 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5845 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5846 + "deleted": true, ~/~/ Признак удаления 5847 + "extId": "string", ~/~/ ExtId 5848 + "GeoIds": [ ~/~/ Связанные поля 5849 + 0 5850 + ] 5851 +} 5852 + 5853 + 5854 +== **Редактирование задания в Журнале заданий** == 5855 + 5856 +(% class="box successmessage" %) 5857 +((( 5858 +**PUT /api/v3/vehicletasks** 5859 +))) 5860 + 5861 +Пример запроса: 5862 + 5863 +((( 5864 +{ 5865 + "vehicleId": 0, ~/~/ Идентификатор ТС 5866 + "description": "string", ~/~/ Описание 5867 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5868 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5869 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5870 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5871 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5872 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5873 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5874 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5875 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5876 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5877 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5878 + "cost": { 5879 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5880 + "Name": "string", ~/~/ Наименование 5881 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5882 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5883 + "Norm": 0 ~/~/ Норма внесения 5884 + }, 5885 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5886 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5887 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5888 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5889 + "deleted": true, ~/~/ Признак удаления 5890 + "extId": "string", ~/~/ ExtId 5891 + "GeoIds": [ ~/~/ Связанные поля 5892 + 0 5893 + ] 5894 +} 5895 +))) 5896 + 5897 + 5898 +Пример ответа: 5899 + 5900 +{ 5901 + "vehicleId": 0, ~/~/ Идентификатор ТС 5902 + "description": "string", ~/~/ Описание 5903 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5904 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5905 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5906 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5907 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5908 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5909 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5910 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5911 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5912 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5913 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5914 + "cost": { 5915 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5916 + "Name": "string", ~/~/ Наименование 5917 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5918 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5919 + "Norm": 0 ~/~/ Норма внесения 5920 + }, 5921 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5922 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5923 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5924 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5925 + "deleted": true, ~/~/ Признак удаления 5926 + "extId": "string", ~/~/ ExtId 5927 + "GeoIds": [ ~/~/ Связанные поля 5928 + 0 5929 + ] 5930 +} 5931 + 5932 + 5933 +== **Удаление задания в Журнале заданий** == 5934 + 5935 +(% class="box warningmessage" %) 5936 +((( 5937 +**DELETE /api/v3/vehicletasks** 5938 +))) 5939 + 5940 +Пример запроса: 5941 + 5942 +((( 5943 +[ 5944 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5945 +] 5946 +))) 5947 + 5948 +((( 5949 + 5950 +))) 5951 + 5952 +Пример ответа: 5953 + 5954 +{ 5955 + "vehicleId": 0, ~/~/ Идентификатор ТС 5956 + "description": "string", ~/~/ Описание 5957 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5958 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5959 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5960 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5961 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5962 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5963 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5964 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5965 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5966 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5967 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5968 + "cost": { 5969 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5970 + "Name": "string", ~/~/ Наименование 5971 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5972 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5973 + "Norm": 0 ~/~/ Норма внесения 5974 + }, 5975 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5976 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5977 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5978 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5979 + "deleted": true, ~/~/ Признак удаления 5980 + "extId": "string", ~/~/ ExtId 5981 + "GeoIds": [ ~/~/ Связанные поля 5982 + 0 5983 + ] 5984 +} 5985 + 5986 + 5987 +== **Получение списка Журнала заданий** == 5988 + 5989 +(% class="box infomessage" %) 5990 +((( 5991 +**POST /api/v3/vehicletasks/getbyperiod** 5992 +))) 5993 + 5994 +Пример запроса: 5995 + 5996 +((( 5997 +{ 5998 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5999 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6000 + "TimeZone": 0, ~/~/ Часовой пояс. 6001 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6002 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6003 + ], 6004 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6005 + 0 6006 + ], 6007 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6008 + 0 6009 + ], 6010 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6011 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6012 +} 6013 +))) 6014 + 6015 + 6016 +Пример ответа: 6017 + 6018 +((( 6019 +{ 6020 + "total": 0, ~/~/ Общее количество записей 6021 + "pages": 0, ~/~/ Общее количество страниц 6022 + "currentPage": 0, ~/~/ Текущая страница 6023 + "items": [ ~/~/ Записи 6024 + { 6025 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6026 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6027 + "name": "string", ~/~/ Название задания. 6028 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6029 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6030 + "workKind": "string", ~/~/ Вид работ 6031 + "techOp": "string", ~/~/ Тех. операция 6032 + "trailerModel": "string", ~/~/ Модель агрегата 6033 + "width": "string", ~/~/ Ширина, м 6034 + "speed": "string", ~/~/ Тех. скорость 6035 + "fields": "string", ~/~/ Поля 6036 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6037 + "vehicles": "string", ~/~/ Объект-модель 6038 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6039 + "drivers": "string", ~/~/ Водители 6040 + "tmc": "string", ~/~/ ТМЦ 6041 + "client": "string", ~/~/ Клиент 6042 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6043 + "dep": "string", ~/~/ Подразделение 6044 + "geoIds": [ ~/~/ Связанные поля 6045 + 0 6046 + ] 6047 + } 6048 + ] 6049 +} 6050 +))) 6051 + 6052 + 6053 += **Раздел: Роли** = 6054 + 6055 +== **Получение списка клиентских и системных ролей пользователя ** == 6056 + 6057 +(% class="box successmessage" %) 6058 +((( 6059 +**POST /api/v3/groups/find** 6060 +))) 6061 + 6062 +Пример запроса: 6063 + 6064 +((( 6065 +{ 6066 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6067 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6068 +} 6069 +))) 6070 + 6071 +((( 6072 + 6073 +))) 6074 + 6075 +((( 6076 +Пример ответа: 6077 +))) 6078 + 6079 +((( 6080 +((( 6081 +{ 6082 + "groups": [ ~/~/ Системные роли пользователя 6083 + { 6084 + "code": "string", ~/~/ Код роли. 6085 + "name": "string", ~/~/ Имя 6086 + "shortName": "string" ~/~/ Короткое имя 6087 + } 6088 + ], 6089 + "customGroups": [ ~/~/ Системные роли пользователя 6090 + { 6091 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6092 + "name": "string", ~/~/ Наименование 6093 + "shortName": "string", ~/~/ Короткое наименование 6094 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6095 + } 6096 + ] 6097 +} 6098 +))) 6099 +))) 6100 + 6101 +((( 6102 + 6103 +))) 6104 + 6105 +((( 6106 + 6107 +))) 6108 + 6109 += **Раздел: Локатор ** = 6110 + 6111 + 6112 +== **Получение данных по локатору** == 6113 + 6114 +(% class="box infomessage" %) 6115 +((( 6116 +**GET /api/v3/locators/{locatorId}** 6117 +))) 6118 + 6119 +В запросе указывается locatorid - идентификатор локатора 6120 + 6121 + 6122 +Пример ответа: 6123 + 6124 +((( 6125 +((( 6126 +{ 6127 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6128 + 0 6129 + ], 6130 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6131 + 0 6132 + ], 6133 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6134 + 0 6135 + ], 6136 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6137 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6138 + "agentName": "string", ~/~/ Наименование агента. 6139 + "isEnabled": true, ~/~/ Активность 6140 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6141 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6142 + "name": "string", ~/~/ Наименование. 6143 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6144 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6145 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6146 + "validity": 0, ~/~/ Значение срока действия 6147 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6148 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6149 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6150 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6151 + "url": "string", ~/~/ Ссылка 6152 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6153 + 6154 + "showVehicleName": true, ~/~/ Наименование объекта 6155 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6156 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6157 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6158 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6159 + "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ГИС) 6160 + 6161 + 1 6162 + 6163 + ] 6164 +} 6165 +))) 6166 +))) 6167 + 6168 + 6169 +((( 6170 +((( 6171 + 6172 +))) 6173 +))) 6174 + 6175 + 6176 +== **Создание локатора** == 6177 + 6178 +(% class="box successmessage" %) 6179 +((( 6180 +**POST /api/v3/locators** 6181 +))) 6182 + 6183 +Пример запроса: 6184 + 6185 +((( 6186 +{ 6187 + "isEnabled": true, ~/~/ Активность 6188 + "name": "string", ~/~/ Наименование локатора 6189 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6190 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6191 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6192 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6193 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6194 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6195 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6196 + 0 6197 + ], 6198 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6199 + 0 6200 + ], 6201 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6202 + 0 6203 + ], 6204 + 6205 + "showVehicleName": true, ~/~/ Наименование объекта 6206 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6207 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6208 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6209 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6210 + "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ГИС) 6211 + 6212 + 1 6213 + 6214 + ] 6215 +} 6216 +))) 6217 + 6218 + 6219 +Пример ответа: 6220 + 6221 +((( 6222 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6223 +))) 6224 + 6225 + 6226 +== **Выводит список локаторов ** == 6227 + 6228 +(% class="box successmessage" %) 6229 +((( 6230 +**POST /api/v3/locators/find** 6231 +))) 6232 + 6233 +Пример запроса: 6234 + 6235 +((( 6236 +{ 6237 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6238 +} 6239 +))) 6240 + 6241 +((( 6242 + 6243 +))) 6244 + 6245 +((( 6246 + 6247 +))) 6248 + 6249 + 6250 +Пример ответа: 6251 + 6252 +((( 6253 +[ 6254 + { 6255 + "vehiclesCount": 0, ~/~/ Количество объектов. 6256 + "geozonesCount": 0, ~/~/ Количество геозон. 6257 + "fieldsCount": 0, ~/~/ Количество полей. 6258 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6259 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6260 + "agentName": "string", ~/~/ Наименование агента. 6261 + "isEnabled": true, ~/~/ Активность локатора 6262 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6263 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6264 + "name": "string", ~/~/ Наименование локатора 6265 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6266 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6267 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6268 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6269 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6270 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6271 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6272 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6273 + "url": "string", ~/~/ ссылка на локатор 6274 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6275 + "showVehicleName": true, ~/~/ Наименование объекта 6276 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6277 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6278 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6279 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6280 + "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ГИС) 6281 + 6282 + 0 6283 + ] 6284 + } 6285 +] 6286 +))) 6287 + 6288 + 6289 +== **Изменение локатора** == 6290 + 6291 +(% class="box infomessage" %) 6292 +((( 6293 +**PUT /api/v3/locators** 6294 +))) 6295 + 6296 +Пример запроса: 6297 + 6298 +((( 6299 +{ 6300 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6301 + "isEnabled": true, ~/~/ Активность 6302 + "name": "string", ~/~/ Наименование 6303 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6304 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6305 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6306 + "autoProlongation": true, ~/~/ Автопродление срока действия 6307 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6308 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6309 + 0 6310 + ], 6311 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6312 + 0 6313 + ], 6314 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6315 + 0 6316 + ], 6317 + "showVehicleName": true, ~/~/ Наименование объекта 6318 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6319 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6320 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6321 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6322 + "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ГИС) 6323 + 6324 + 0 6325 + 6326 + ] 6327 +} 6328 + 6329 + 6330 +))) 6331 + 6332 +Пример ответа: 6333 + 6334 +200 ~/~/ Success 6335 + 6336 + 6337 +== **Удалить локатор** == 6338 + 6339 +(% class="box warningmessage" %) 6340 +((( 6341 +**DELETE /api/v3/locators** 6342 +))) 6343 + 6344 +Пример запроса: 6345 + 6346 +((( 6347 +[ 6348 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6349 +] 6350 +))) 6351 + 6352 + 6353 += **Раздел: Яндекс Маршруты** = 6354 + 6355 + 6356 +== **Возвращение списка маршрутов** == 6357 + 6358 +(% class="box infomessage" %) 6359 +((( 6360 +**GET /api/v3/TransportRoutes** 6361 +))) 6362 + 6363 +Пример запроса: 6364 +Id ~/~/ Идентификатор поля 6365 + 6366 +Пример ответа: 6367 + 6368 +((( 6369 +[ 6370 + { 6371 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6372 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6373 + "name": "string", ~/~/ Наименование маршрута. 6374 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6375 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6376 + 0 6377 + ] 6378 + } 6379 +] 6380 +))) 6381 + 6382 + 6383 +== **Добавить маршрут** == 6384 + 6385 +(% class="box infomessage" %) 6386 +((( 6387 +**POST /api/v3/TransportRoutes** 6388 +))) 6389 + 6390 +Пример запроса: 6391 +{ 6392 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6393 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6394 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6395 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6396 + 0 6397 + ] 6398 +} 6399 + 6400 + 6401 +Пример ответа: 6402 + 6403 +((( 6404 +{ 6405 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6406 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6407 + "name": "string", ~/~/ Определяет наименование маршрута 6408 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6409 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6410 + 0 6411 + ] 6412 +} 6413 +))) 6414 + 6415 + 6416 +== **Обновление маршрута** == 6417 + 6418 +(% class="box successmessage" %) 6419 +((( 6420 +**PUT /api/v3/TransportRoutes** 6421 +))) 6422 + 6423 +Пример запроса: 6424 + 6425 +((( 6426 +{ 6427 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6428 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6429 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6430 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6431 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6432 + 0 6433 + ] 6434 +} 6435 +))) 6436 + 6437 +Пример ответа: 6438 + 6439 +((( 6440 +{ 6441 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6442 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6443 + "name": "string", ~/~/ Определяет наименование маршрута 6444 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6445 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6446 + 0 6447 + ] 6448 +} 6449 +))) 6450 + 6451 + 6452 +== **Получить связки маршрутов ТС** == 6453 + 6454 +(% class="box infomessage" %) 6455 +((( 6456 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6457 +))) 6458 + 6459 +Пример запроса: 6460 + 6461 +((( 6462 +[ 6463 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6464 +] 6465 +))) 6466 + 6467 +Пример ответа: 6468 + 6469 +((( 6470 +[ 6471 + { 6472 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6473 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6474 + } 6475 +] 6476 +))) 6477 + 6478 + 6479 +== **Удалить маршрут** == 6480 + 6481 +(% class="box warningmessage" %) 6482 +((( 6483 +**DELETE /api/v3/TransportRoutes/{id}** 6484 +))) 6485 + 6486 +Пример запроса: 6487 +Id ~/~/ Идентификатор поля 6488 + 6489 + 6490 += **Раздел: Управление доступа к машинам** = 6491 + 6492 + 6493 +== Получение списка транспортных средств видимых пользователю == 6494 + 6495 +(% class="box infomessage" %) 6496 +((( 6497 +**GET /api/v3/UserVisibleVehicles/{userId}** 6498 +))) 6499 + 6500 +Пример ответа: 6501 + 6502 +((( 6503 +{ 6504 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6505 + 0 6506 + ] 6507 +} 6508 +))) 6509 + 6510 + 6511 +== Задает видимость транспортных средств пользователю == 6512 + 6513 +(% class="box infomessage" %) 6514 +((( 6515 +**POST /api/v3/UserVisibleVehicles** 6516 +))) 6517 + 6518 +Пример запроса: 6519 + 6520 +((( 6521 +((( 6522 +{ 6523 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6524 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6525 + 0 6526 + ] 6527 +} 6528 +))) 6529 + 6530 +((( 6531 + 6532 +))) 6533 + 6534 +((( 6535 +Пример ответа : 6536 +))) 6537 + 6538 +((( 6539 + 6540 +))) 6541 + 6542 +((( 6543 +200 ~/~/ Success 6544 +))) 6545 +))) 6546 + 6547 + 2418 2418 (% class="box" lang="en-US" style="text-align: center;" %) 2419 2419 ((( 2420 2420 (% 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