Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/04/24 15:46
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,51 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 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" ~/~/ Корр. счет127 + "agentId": "", (%%) 128 + "parentId": "", 129 + "parentName": "string", 130 + "name": "string", 131 + "fullName": "string", 132 + "agentInfoType": 0, 133 + "isForeign": true/false, 134 + "district": "string", 135 + "region": "string", 136 + "city": "string", 137 + "inn": "string", 138 + "kpp": "string", 139 + "address": "string", 140 + "addressFact": "string", 141 + "email": "string", 142 + "director": "string", 143 + "bankName": "string", 144 + "bankBIK": "string", 145 + "bankRS": "string", 146 + "bankKS": "string" 118 118 } 119 119 149 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 150 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 151 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 152 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 153 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 154 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 155 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 156 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 157 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 158 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 159 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 160 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 161 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 162 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 163 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 164 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 165 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 166 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 167 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 168 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 169 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 170 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».184 +(% 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 - Отказ) 199 + "agentId": "",(% style="color:#000000" %) (%%) 200 + "parentId": "", 201 + "name": "string", 202 + "fullName": "string", 203 + "agentInfoType": 0, 204 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 207 + 208 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 209 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 210 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 211 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 212 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 213 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 214 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 215 + 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 - 234 + "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 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 278 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 279 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 280 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 281 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 282 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 283 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 284 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 285 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 286 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 287 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 288 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 289 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 290 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 291 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 292 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 293 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 294 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 295 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 296 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 297 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 298 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 299 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -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 381 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 382 + 383 +(% class="box warningmessage" %) 384 +((( 385 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 386 +))) 387 + 388 +Метод позволяет изменить статус клиента, указанного в запросе. 389 + 390 +В пути указывается GUID клиента и статус клиента. 391 + 392 +**status **- значение 0 - заблокирован, 1 - активен. 393 + 394 +Ответ: Code 204 395 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 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 пользователя 460 +{ 461 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 478 +} 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 - 500 +(% 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 пользователя 596 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 597 + "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" %) 619 + "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": "" , ~/~/ идентификатор пользователя 626 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 627 + "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» названия группы пользователя 648 +} 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 - 669 +(% 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 - 694 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 803 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 900 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 901 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 902 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 903 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 904 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 905 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 906 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 907 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 908 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 909 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 910 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 911 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 912 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 967 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 968 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 969 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 970 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 971 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 972 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 973 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 974 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 975 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 976 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 977 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 978 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 979 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 980 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1000 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -930,6 +930,17 @@ 930 930 931 931 ((( 932 932 { 1029 + 1030 +((( 1031 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1032 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1033 +))) 1034 + 1035 +((( 1036 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1037 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1038 +))) 1039 + 933 933 "vehicleId": "", ~/~/ ID объекта 934 934 "name": "", ~/~/ Имя объекта 935 935 "imei": "", ~/~/ IMEI объекта ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1078 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1030,6 +1030,7 @@ 1030 1030 ], 1031 1031 "showInTooltip": true, ~/~/ Отображать в подсказке 1032 1032 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1134 + "color": "string", ~/~/ Код цвета датчиков 1033 1033 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1034 1034 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1035 1035 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,19 +1094,27 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1186 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", 1102 1102 "description": "string", 1103 1103 "additionalInfo": "string" 1104 - } 1105 - ] 1106 1106 1193 +((( 1107 1107 } 1195 + ], 1196 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1197 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1108 1108 ))) 1109 1109 1200 +((( 1201 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1202 +} 1203 + 1204 +))) 1205 +))) 1206 + 1110 1110 (% style="text-align:left" %) 1111 1111 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1112 1112 ... ... @@ -1113,6 +1113,75 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1213 + 1214 +== **Отправить команду на терминал** == 1215 + 1216 +(% class="box successmessage" %) 1217 +((( 1218 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1219 +))) 1220 + 1221 +Команда для отправки на тс. 1222 + 1223 +{ 1224 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1225 +"command": "", ~/~/ Текст отправляемой команды 1226 +"retries": "", ~/~/ Количество попыток отправки на терминал 1227 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1228 +} 1229 + 1230 +В ответ получаем cmdid 1231 + 1232 + 1233 +== **Получить ответ на отправленную на ТС команду** == 1234 + 1235 +(% class="box infomessage" %) 1236 +((( 1237 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1238 +))) 1239 + 1240 +Идентификатор команды: cmdId 1241 + 1242 +Запрос от терминала на ответ команды 1243 + 1244 +Пример ответ от терминала: 1245 + 1246 +ID= "" ~/~/ идентификатор объекта 1247 +Soft="" ~/~/ версия софта 1248 +GPS=4 ~/~/ тип трекера 1249 +Time=11:05:43 28.06.24 ~/~/ время запроса 1250 +Lat=45.056221 ~/~/ широта 1251 +Lon=39.035938 ~/~/ долгота 1252 +Speed=0.0 ~/~/ скорость 1253 +Course=181.4 ~/~/направление 1254 + 1255 +((( 1256 +== **Список отправленных объекту команд с ответами** == 1257 + 1258 +(% class="box infomessage" %) 1259 +((( 1260 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1261 +))) 1262 + 1263 +Идентификатор ТС: vehicleId 1264 + 1265 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1266 + 1267 +Пример ответа терминала 1268 + 1269 +[ 1270 +{ 1271 +"id": "", ~/~/ идентификатор пользователя 1272 +"commandText": "", ~/~/Текст команды. 1273 +"templateId": "", ~/~/Идентификатор шаблона 1274 +"updated": "", ~/~/ Время отправки 1275 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1276 +"answer": "", ~/~/ Ответ терминала. 1277 +"status": "" ~/~/ Статус отправки 1278 +} 1279 +] 1280 +))) 1281 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1132,6 +1132,11 @@ 1132 1132 1133 1133 (% style="color:#000000" %){ 1134 1134 1301 + 1302 +((( 1303 + "vehicleId": 0, ~/~/ ID ТС 1304 +))) 1305 + 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1372 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1227,6 +1227,7 @@ 1227 1227 ], 1228 1228 "showInTooltip": true, ~/~/ Отображать в подсказке 1229 1229 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1398 + "color": "string", ~/~/ код цвета датчиков 1230 1230 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1231 1231 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1232 1232 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1239,103 +1239,293 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1423 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1424 + 1425 +((( 1426 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1427 + { 1428 + "from": 0, ~/~/ С какого значения 1429 + "color": "string", ~/~/ Каким цветом 1430 + "text": "string" ~/~/ Текст подписи к этому интервалу 1431 + } 1432 + ] 1267 1267 } 1268 1268 ], 1435 +))) 1436 + 1437 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1438 + 1439 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1277 - } 1278 - ] 1442 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1443 + "name": "string", ~/~/ Наименование произвольного поля 1444 + "value": "string", ~/~/ Значение произвольного поля 1445 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1446 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1447 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1448 + 1449 +((( 1450 + } 1451 + ], 1452 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1453 +))) 1454 + 1455 +((( 1456 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1279 1279 } 1458 +))) 1280 1280 1460 + 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1464 +((( 1465 +((( 1466 +((( 1467 +{ 1468 + "vehicleId": 0, ~/~/ ID ТС 1469 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1470 + "name": "string", ~/~/ Имя объекта 1471 + "imei": "string", ~/~/ IMEI 1472 + "deviceTypeId": 0, ~/~/ ID типа устройства 1473 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1474 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1475 + "sim1": "string", ~/~/ SIM1 1476 + "sim2": "string", ~/~/ SIM2 1477 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1478 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1479 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1480 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1481 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1482 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1483 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1484 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1485 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1486 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1487 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1488 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1489 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1490 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1491 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1492 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1493 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1494 + "counters": { ~/~/ Dto для состояний счётчиков 1495 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1496 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1497 + "mileage": 0, ~/~/ Пробег 1498 + "motohours": 0 ~/~/ Моточасы 1499 + }, 1500 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1501 + "id": "string", ~/~/ CMSV6 Идентификатор 1502 + "enabled": true, ~/~/ Признак включения 1503 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1504 + "login": "string", ~/~/ CMSV6 имя учетной записи 1505 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1506 + }, 1507 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1508 + { 1509 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1510 + "enabled": true, ~/~/ Признак включения 1511 + "name": "string", ~/~/ Имя задания 1512 + "description": "string", ~/~/ Описание задания 1513 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1514 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1515 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1516 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1517 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1518 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1519 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1520 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 1522 + ], 1523 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1524 + { 1525 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1526 + "inputNumber": 0, ~/~/ № входа. 1527 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1528 + "comment": "string", ~/~/ Комментарий 1529 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1530 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1531 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1532 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1533 + } 1534 + ], 1535 + "commandTemplates": [ ~/~/ Список шаблонов команд 1536 + { 1537 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1538 + "name": "string", ~/~/ Название шаблона команд 1539 + "command": "string", ~/~/ Команда на выполнение 1540 + "retries": 0 ~/~/ Лимит попыток отправки 1541 + } 1542 + ], 1543 + "sensors": [ ~/~/ Список датчиков 1544 + { 1545 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1546 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1547 + "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 1548 + "name": "string", ~/~/ Имя датчика 1549 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1550 + "inputNumber": 0, ~/~/ Номер входа 1551 + "pseudonym": "string", ~/~/ Псевдоним 1552 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1553 + "isInverted": true, ~/~/ Признак инверсии 1554 + "disabled": true, ~/~/ Датчик не участвует в обработке 1555 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1556 + "gradesTables": [ ~/~/ Тарировка 1557 + { 1558 + "grades": [ ~/~/ Таблицы тарировки 1559 + { 1560 + "input": 0, ~/~/ Вход 1561 + "output": 0 ~/~/ Выход 1562 + } 1563 + ], 1564 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1565 + } 1566 + ], 1567 + "showInTooltip": true, ~/~/ Отображение в подсказке 1568 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1569 + "color": "string", ~/~/ код цвета датчиков 1570 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1571 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1572 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1573 + "expr": "string", ~/~/ Выражение 1574 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1575 + "string" 1576 + ], 1577 + "customParams": { 1578 + "additionalProp1": "string", 1579 + "additionalProp2": "string", 1580 + "additionalProp3": "string" 1581 + }, 1582 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1583 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1584 + { 1585 + "from": 0, ~/~/ С какого значения 1586 + "color": "string", ~/~/ Каким цветом 1587 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% style="color:#000000" %)} 1589 +((( 1590 + "text": "string" ~/~/ Текст подписи к этому интервалу 1591 + } 1592 + ] 1593 + } 1594 + ], 1595 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1596 + "customFields": [ ~/~/ Список произвольных полей 1597 + { 1598 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1599 + "name": "string", ~/~/ Наименование произвольного поля 1600 + "value": "string", ~/~/ Значение произвольного поля 1601 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1602 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1603 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1604 + } 1605 + ], 1606 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1607 +} 1608 +))) 1609 +))) 1610 +))) 1325 1325 1612 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1332 1332 1619 +== **Импортировать историю ТС (Асинхронный запрос)** == 1620 + 1621 +(% class="box successmessage" %) 1622 +((( 1623 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1624 +))) 1625 + 1626 +Метод запроса: **POST** 1627 + 1628 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1629 + 1630 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1631 + 1632 + 1633 +Ответ: 1634 + 1635 +{ 1636 + 1637 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1638 + 1639 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1640 + 1641 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1642 + 1643 + "Message": "string", ~/~/ Информация о выполнении запроса 1644 + 1645 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1646 + 1647 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1648 + 1649 + "Data": "string" ~/~/ Данные 1650 + 1651 +} 1652 + 1653 + 1654 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1655 + 1333 1333 (% class="box infomessage" %) 1334 1334 ((( 1658 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1659 +))) 1660 + 1661 +Метод запроса: **GET** 1662 + 1663 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1664 + 1665 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1666 + 1667 + 1668 +Ответ: 1669 + 1670 +{ 1671 + 1672 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1673 + 1674 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1675 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1676 + 1677 + "Message": "string", ~/~/ Информация о выполнении запроса 1678 + 1679 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1680 + 1681 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1682 + 1683 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1684 + 1685 + "Data": "string" ~/~/ Данные 1686 + 1687 +} 1688 + 1689 + 1690 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1691 + 1692 +(% class="box infomessage" %) 1693 +((( 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1697 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1369,9 +1369,12 @@ 1369 1369 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1370 1370 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1371 1371 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1372 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1373 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1374 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1731 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1732 + "unitName": "string", ~/~/ Название подразделения (опционально) 1733 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1734 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1735 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1736 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1375 1375 } 1376 1376 1377 1377 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1378,8 +1378,14 @@ 1378 1378 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 -(% style="color:#000000" %){ 1743 +(% style="color:#000000" %)[ 1744 +{ 1382 1382 1746 +((( 1747 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1748 +))) 1749 + 1750 +((( 1383 1383 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта ... ... @@ -1405,9 +1405,21 @@ 1405 1405 "forClient": true, ~/~/ право на отображение у клиента 1406 1406 "forTooltip": false, ~/~/ право на отображение в подсказке 1407 1407 "forReport": false ~/~/ право на отображение в отчетах 1408 - }(%%) 1409 -(% style="color:#000000" %)} 1776 +))) 1410 1410 1778 +((( 1779 + } 1780 + ], 1781 + "vehicleGroups": [ ~/~/ Группы ТС 1782 + { 1783 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1784 + "name": "string" ~/~/ Наименование группы ТС 1785 + } 1786 + ] 1787 + } 1788 +] 1789 +))) 1790 + 1411 1411 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1412 1412 1413 1413 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1826 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,10 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1835 +== == 1836 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1531,9 +1531,19 @@ 1531 1531 1532 1532 "drivers": [ ~/~/ Водители 1533 1533 { 1534 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 - "isDefault": true 1536 - } 1912 + 1913 +((( 1914 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1915 + "inputNumber": 0, ~/~/ № входа. 1916 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1917 + "comment": "string", ~/~/ Комментарий. 1918 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1919 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1920 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1921 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1922 +))) 1923 + 1924 + } 1537 1537 ], 1538 1538 "commandTemplates": [ ~/~/ Шаблон команды 1539 1539 { ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1934 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1570,6 +1570,11 @@ 1570 1570 ], 1571 1571 "showInTooltip": true, ~/~/ Отображать в подсказке 1572 1572 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1960 + 1961 +((( 1962 + "color": "string",** ~/~/ **Цвет датчика 1963 +))) 1964 + 1573 1573 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 1574 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 1575 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1582,95 +1582,225 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1990 + 1991 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1992 + { 1993 + "from": 0, ~/~/ С какого значения 1994 + "color": "string", ~/~/ Каким цветом 1995 + "text": "string" ~/~/ Текст подписи к этому интервалу 1996 + } 1997 + ] 1610 1610 } 1611 1611 ], 2000 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2001 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 2003 + { 2004 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2005 + "name": "string", ~/~/ Наименование произвольного поля 2006 + "value": "string", ~/~/ Значение произвольного поля 2007 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2008 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2009 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 - ] 2011 + 2012 +((( 2013 + ], 2014 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2015 +))) 2016 + 1622 1622 } 1623 1623 2019 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 2022 +((( 2023 +{ 2024 + "vehicleId": 0, ~/~/ ID ТС 2025 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 2026 + "name": "string", ~/~/ Имя объекта 2027 + "imei": "string", ~/~/ IMEI 2028 + "deviceTypeId": 0, ~/~/ ID типа устройства 2029 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 2030 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 2031 + "sim1": "string", ~/~/ SIM1 2032 + "sim2": "string", ~/~/ SIM2 2033 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 2034 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 2035 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 2036 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 2037 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 2038 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 2039 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 2040 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 2041 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 2042 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 2043 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 2044 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 2045 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 2046 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 2047 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 2048 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 2049 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 2050 + "counters": { ~/~/ состояний счётчиков 2051 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 2052 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 2053 + "mileage": 0, ~/~/ Пробег 2054 + "motohours": 0 ~/~/ Моточасы 2055 + }, 2056 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2057 + "id": "string", ~/~/ CMSV6 Идентификатор 2058 + "enabled": true, ~/~/ Признак включения 2059 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2060 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 2062 + 2063 +((( 2064 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2065 + "login": "string", ~/~/ CMSV6 имя учетной записи 2066 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2067 + }, 2068 + "inspectionTasks": [ ~/~/ Задания на ТО 2069 + { 2070 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2071 + "enabled": true, ~/~/ Признак включения 2072 + "name": "string", ~/~/ Имя задания 2073 + "description": "string", ~/~/ Описание задания 2074 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2075 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2076 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2077 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2078 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2079 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2080 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2081 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2082 + } 2083 + ], 2084 + "drivers": [ ~/~/ Список водителей 2085 + { 2086 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2087 + "inputNumber": 0, ~/~/ № входа. 2088 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2089 + "comment": "string", ~/~/ Комментарий. 2090 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2091 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2092 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2093 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2094 + } 2095 + ], 2096 + "commandTemplates": [ ~/~/ Список шаблонов команд 2097 + { 2098 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2099 + "name": "string", ~/~/ Название шаблона команд 2100 + "command": "string", ~/~/ Команда на выполнение 2101 + "retries": 0 ~/~/ Лимит попыток отправки 2102 + } 2103 + ], 2104 + "sensors": [ ~/~/ Список датчиков 2105 + { 2106 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2107 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2108 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2109 +))) 2110 + 2111 +((( 2112 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2113 +))) 2114 + 2115 +((( 2116 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2117 +))) 2118 + 2119 +((( 2120 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2121 +))) 2122 + 2123 +((( 2124 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2125 +))) 2126 + 2127 +((( 2128 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2129 + "name": "string", ~/~/ Имя датчика 2130 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2131 +))) 2132 + 2133 +((( 2134 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2135 + "inputNumber": 0, ~/~/ Номер входа 2136 + "pseudonym": "string", ~/~/ Псевдоним 2137 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2138 + "isInverted": true, ~/~/ Признак инверсии 2139 + "disabled": true, ~/~/ Датчик не участвует в обработке 2140 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2141 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1657 - { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2143 + "grades": [ ~/~/ Таблицы тарировки 2144 + { 2145 + "input": 0, ~/~/ Вход 2146 + "output": 0 ~/~/ Выход 2147 + } 2148 + ], 2149 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1669 1669 } 2151 + ], 2152 + "showInTooltip": true, ~/~/ Отображение в подсказке 2153 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2155 +((( 2156 + "color": "string", ~/~/ цвет уведомлений 2157 +))) 1673 1673 2159 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2160 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2161 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2162 + "expr": "string", ~/~/ Выражение 2163 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2164 + "string" 2165 + ], 2166 + "customParams": { ~/~/ Дополнительные настройки 2167 + "additionalProp1": "string", 2168 + "additionalProp2": "string", 2169 + "additionalProp3": "string" 2170 + }, 2171 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2172 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2173 + { 2174 + "from": 0, ~/~/ С какого значения 2175 + "color": "string", ~/~/ Каким цветом 2176 + "text": "string" ~/~/ Текст подписи к этому интервалу 2177 + } 2178 + ] 2179 + } 2180 + ], 2181 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2182 + "customFields": [ ~/~/ Список произвольных полей 2183 + { 2184 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2185 + "name": "string", ~/~/ Наименование произвольного поля 2186 + "value": "string", ~/~/ Значение произвольного поля 2187 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2188 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2189 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2190 + } 2191 + ], 2192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2193 +} 2194 +))) 2195 + 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2234 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2240 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2264 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2311 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2312 + 2313 +(% class="box infomessage" style="text-align: left;" %) 2314 +((( 2315 +**POST /api/v3/terminalMessages/mapping** 2316 +))) 2317 + 2318 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2319 + 2320 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2321 + 2322 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2323 + 2324 +{ 2325 + "protocolType": 0, 2326 + "params": ["string"] 2327 +} 2328 + 2329 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2330 +|protocolType|ID типа протокола 2331 +|params|((( 2332 +Массив наименований параметров в сообщении 2333 +))) 2334 + 2335 +Ответ: 2336 + 2337 +{ 2338 + "protocolType": 0, 2339 + "mapping": { 2340 + "additionalProp1": { 2341 + "inputType": 0, 2342 + "inputNumber": 0 2343 + }, 2344 + "additionalProp2": { 2345 + "inputType": 0, 2346 + "inputNumber": 0 2347 + } 2348 + } 2349 +} 2350 + 2351 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2352 +|protocolType|Тип протокола 2353 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2354 +|inputNumber|((( 2355 +Номер входа 2356 +))) 2357 + 2358 +(% class="wikigeneratedid" %) 2359 +Перечень 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/]] 2360 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2385 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2386 +|vehicleId|ID объекта 2387 +|from|Дата и время начала периода запроса 2388 +|to|Дата и время окончания периода запроса 2389 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2396 + "deviceTime": "2023-11-29T07:40:44.052Z", 2397 + "serverTime": "2023-11-29T07:40:44.052Z", 2398 + "speed": 0, 2399 + "altitude": 0, 2400 + "latitude": 0, 2401 + "longitude": 0, 2402 + "satellites": 0, 2403 + "course": 0, 2404 + "voltage": 0, 2405 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2410 + "photoCount": 0, 2411 + "lbsCorrectedCoords": true, 2412 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2418 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2419 +|deviceTime|Время сообщения терминала 2420 +|serverTime|Время когда сообщение поступило на сервер 2421 +|speed|Скорость 2422 +|altitude|Высота над уровнем моря 2423 +|latitude|Широта 2424 +|longitude|Долгота 2425 +|satellites|Кол-во спутников 2426 +|course|Курс 2427 +|voltage|Бортовое напряжение 2428 +|parameters|Список параметров и их значений 2429 +|photoCount|Количество фото 2430 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2431 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1932,10 +1932,14 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2469 + "mileage": 0, ~/~/ Пробег за период, километры 2470 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2471 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2472 + "motohours": 0, ~/~/ Моточасы за период, секунды 2473 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2474 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2475 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2476 + 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1979,11 +1979,19 @@ 1979 1979 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1980 1980 "fuelConsumption": 0, ~/~/ Расход топлива 1981 1981 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2520 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2521 + 1982 1982 } 1983 1983 ] 1984 1984 } 1985 1985 ] 1986 1986 2527 +(% class="box warningmessage" %) 2528 +((( 2529 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2530 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2531 +))) 2532 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2018,7 +2018,8 @@ 2018 2018 "model": "string", ~/~/ Модель объекта 2019 2019 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 2020 { 2021 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2567 + "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 2568 + 2022 2022 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 2023 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 2024 "valueFuel": 0, ~/~/ Количество ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2579 + 2580 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2581 + 2582 +(% class="box infomessage" %) 2583 +((( 2584 +**POST /api/v3/vehicles/moveStop** 2585 +))) 2586 + 2587 +Метод запроса: **POST** 2588 + 2589 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2590 + 2591 +В заголовках запроса: X-Auth: Токен авторизации 2592 + 2593 + 2594 +Тело запроса: 2595 + 2596 +{ 2597 + "vehicleIds": [ ], ~/~/ Список ID объектов 2598 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2599 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2600 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2601 +} 2602 + 2603 +Ответ: 2604 + 2605 +[ 2606 + { 2607 + "vehicleId": 0, ~/~/ ID объекта 2608 + "vehicleName": "string", ~/~/ Имя объекта 2609 + "moves": [ ~/~/ Событие движения 2610 + { 2611 + "mileage": 0, ~/~/ Пробег, км 2612 + "eventId": 0, ~/~/ Идентификатор события 2613 + "eventName": "string", ~/~/ Название события 2614 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2615 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2616 + "duration": 0 ~/~/ Продолжительность события, секунд 2617 + } 2618 + ], 2619 + "stops": [ ~/~/ События стоянок 2620 + { 2621 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2622 + "eventId": 0, ~/~/ Идентификатор события 2623 + "eventName": "string", ~/~/ Название события 2624 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2625 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2626 + "duration": 0 ~/~/ Продолжительность события, секунд 2627 + } 2628 + ] 2629 + } 2630 +] 2631 + 2632 + 2633 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2634 + 2635 +(% class="box infomessage" %) 2636 +((( 2637 +**POST /api/v3/vehicles/getlastdata** 2638 +))) 2639 + 2640 +Метод запроса: **POST** 2641 + 2642 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2643 + 2644 +В заголовках запроса: X-Auth: Токен авторизации 2645 + 2646 + 2647 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2648 + 2649 +Ответ: 2650 + { 2651 + "vehicleId": 0, ~/~/Идентификатор объекта. 2652 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2653 + "vehicleNumber": "string",~/~/Номер объекта. 2654 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2655 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2656 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2657 + "speed": 0,~/~/Скорость объекта. 2658 + "course": 0,~/~/Курс движения [0;360] 2659 + "latitude": 0,~/~/Широта [-90°;90°]. 2660 + "longitude": 0,~/~/Долгота [-180°;180°]. 2661 + "address": "string",~/~/Адрес. 2662 + "geozones": [ ~/~/Сведения по геозонам. 2663 + { 2664 + "id": 0, 2665 + "name": "string" 2666 + } 2667 + 2668 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 2976 + 2977 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2978 + 2979 +(% class="box warningmessage" %) 2980 +((( 2981 +**PUT** /api/v3/notifications/prolongation 2982 +))) 2983 + 2984 +Метод позволяет продлить уведомления. 2985 + 2986 +Метод запроса **PUT** 2987 + 2988 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2989 + 2990 +В заголовках запроса: X-Auth: Токен авторизации. 2991 + 2992 +Тело запроса: 2993 + 2994 +[ 2995 + 2996 +0 2997 + 2998 +] 2999 + 3000 +где 0 идентификатор ids. 3001 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3593 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3594 + 3595 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3596 + 3597 +(% class="box infomessage" %) 3598 +((( 3599 +**POST /api/v3/Trailers** 3600 +))) 3601 + 3602 +Пример запроса: 3603 + 3604 +{ 3605 + "startDate": "2023-11-14T10:48:03.671Z", 3606 + "endDate": "2023-11-14T10:48:03.671Z", 3607 + "ids": [ 0 ], 3608 + "timezone": 0 3609 +} 3610 + 3611 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3612 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3613 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3614 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3615 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3616 + 3617 +Пример ответа: 3618 + 3619 +[ 3620 + { 3621 + "SD": "2023-11-14T10:48:03.717Z", 3622 + "ED": "2023-11-14T10:48:03.717Z", 3623 + "id": 0, 3624 + "SLat": 0, 3625 + "SLon": 0, 3626 + "ELat": 0, 3627 + "ELon": 0, 3628 + "mileage": 0 3629 + "Duration": 0 3630 + "Address": "string", 3631 + "Address2": "string", 3632 + "name": "string", 3633 + "rid": "string", 3634 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3635 + "trailer": { 3636 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3637 + "Number": "string", 3638 + "Description": "string", 3639 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3640 + "ExternalID": "string", 3641 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3642 + "CreateTime": "2023-11-14T10:48:03.717Z", 3643 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3644 + "IsDeleted": true 3645 + }, 3646 + "filesCount": 0, 3647 + } 3648 +] 3649 + 3650 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3651 +|SD|Дата и время начала события 3652 +|ED|Дата и время окончания события 3653 +|id|ID объекта 3654 +|SLat|Широта начальной координаты 3655 +|SLon|Долгота начальной координаты 3656 +|ELat|Широта конечной координаты 3657 +|ELon|Долгота конечной координаты 3658 +|mileage|Пробег 3659 +|Duration|Продолжительность 3660 +|Address|Адрес начального местоположения 3661 +|Address2|Адрес конечного местоположения 3662 +|name|Имя радиометки 3663 +|rid|Номер радиометки 3664 +|rguid|ID радиометки 3665 +|trailer|Информация об агрегате 3666 +|ModelGuid|ID агрегата 3667 +|Number|Название/номер агрегата 3668 +|Description|Текст примечания агрегата 3669 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3691 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3697 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3698 +|parentId|ID клиента 3699 +|name|Название карты-метки 3700 +|number|Номер 3701 +|period|Период запросов в секундах (работает только для агрегатов) 3702 +|id|ID карты-метки 3703 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3719 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3725 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3726 +|name|Название карты-метки 3727 +|number|Номер 3728 +|period|Период запросов в секундах (работает только для агрегатов) 3729 +|id|ID карты-метки 3730 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3758 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3759 +|name|Название карты-метки 3760 +|number|Номер 3761 +|period|Период запросов в секундах (работает только для агрегатов) 3762 +|id|ID карты-метки 3763 +|parentId|ID клиента 3764 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3792 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3793 +|name|Название карты-метки 3794 +|number|Номер 3795 +|period|Период запросов в секундах (работает только для агрегатов) 3796 +|id|ID карты-метки 3797 +|parentId|ID клиента 3798 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3806 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 4047 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4048 + 3286 3286 Тело запроса: 3287 3287 3288 3288 { ... ... @@ -3296,6 +3296,50 @@ 3296 3296 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3297 3297 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3298 3298 4062 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4063 + 4064 +(% class="box warningmessage" %) 4065 +((( 4066 +**PUT /api/v3/billing/client/balance/deposit** 4067 +))) 4068 + 4069 +Создает операцию **Пополнение **с указанной суммой 4070 + 4071 +Тело запроса: 4072 + 4073 +{ 4074 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4075 + "Balance": 0 4076 +} 4077 + 4078 +Ответ: Success 4079 + 4080 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4081 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4082 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4083 + 4084 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4085 + 4086 +Создает операцию **Списание **с указанной суммой 4087 + 4088 +(% class="box warningmessage" %) 4089 +((( 4090 +**PUT /api/v3/billing/client/balance/withdraw** 4091 +))) 4092 + 4093 +Тело запроса: 4094 + 4095 +{ 4096 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4097 + "Balance": 0 4098 +} 4099 + 4100 +Ответ: Success 4101 + 4102 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4103 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4104 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4105 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3368,6 +3368,1769 @@ 3368 3368 |PeriodValue|Значение периода. 3369 3369 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3370 3370 4178 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4179 + 4180 +(% class="box warningmessage" %) 4181 +((( 4182 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4183 +))) 4184 + 4185 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4186 + 4187 +(% class="box infomessage" %) 4188 +((( 4189 +**POST /api/v3/vehicles/import/{agentId}** 4190 +))) 4191 + 4192 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4193 + 4194 +В пути указывается **agentId** - id клиента. 4195 + 4196 +**Заголовок** 4197 + 4198 +**X-Auth: [токен авторизации]** 4199 + 4200 +**Параметры** 4201 + 4202 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4203 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4204 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4205 + 4206 +В теле использовать тип **form-data,** тип значения** file** 4207 + 4208 +**Ключи** 4209 + 4210 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4211 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4212 +|csv|В значении передаем файл датчиков, формат **csv** 4213 + 4214 +Ответ: 4215 + 4216 +{ 4217 + "vehicleId": 0, 4218 + "name": "string", 4219 + "errors": ["string"] 4220 +} 4221 + 4222 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4223 +|vehicleId|ID созданного объекта 4224 +|name|Имя созданного объекта 4225 +|errors|Ошибки и их описание 4226 + 4227 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4228 + 4229 +(% class="box infomessage" %) 4230 +((( 4231 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4232 +))) 4233 + 4234 +(% class="wikigeneratedid" %) 4235 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4236 + 4237 +(% class="wikigeneratedid" %) 4238 +В пути указывается **vehicleId **- id объекта. 4239 + 4240 +**Заголовок** 4241 + 4242 +**X-Auth: [токен авторизации]** 4243 + 4244 +В теле использовать тип **form-data.** 4245 + 4246 +Ключи: 4247 + 4248 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4249 +|**history**|В значении передавать файл с историей 4250 + 4251 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4252 + 4253 +Ответ: 4254 + 4255 +{ 4256 + "results": [ 4257 + { 4258 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4259 + "vehicleId": 0, 4260 + "errors": [ 4261 + "string" 4262 + ], 4263 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4264 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4265 + "producedCount": 0, 4266 + "msgCount": 0 4267 + } 4268 + ] 4269 +} 4270 + 4271 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4272 +|results|Результаты импорта в разрезе ТС 4273 +|vehicleGuid|Guid ТС 4274 +|vehicleId|ID ТС 4275 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4276 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4277 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4278 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4279 +|msgCount|Кол-во обработанных сообщений всего 4280 + 4281 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4282 + 4283 +(% class="box infomessage" %) 4284 +((( 4285 +**GET /api/v3/vehicles/import/history/status** 4286 +))) 4287 + 4288 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4289 + 4290 +Ответ: 4291 + 4292 +{ 4293 + "activity": true, 4294 + "progress": 0, 4295 + "message": "string" 4296 +} 4297 + 4298 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4299 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4300 +|progress|Guid ТС 4301 + 4302 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4303 + 4304 +(% class="box infomessage" %) 4305 +((( 4306 +**POST /api/v3/vehicles/export** 4307 +))) 4308 + 4309 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4310 + 4311 +Тело запроса: 4312 + 4313 +[ 4314 + id 4315 +] 4316 + 4317 +Ответ: Success 200, получаете файлы с настройками. 4318 + 4319 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4320 + 4321 +(% class="box infomessage" %) 4322 +((( 4323 +**POST /api/v3/vehicles/export/history** 4324 +))) 4325 + 4326 +Метод возвращает список сообщений терминала объекта за выбранный период. 4327 + 4328 +Тело запроса: 4329 + 4330 +{ 4331 + "vehicleId": 0, 4332 + "asArchive": true, 4333 + "from": "2023-09-27T12:17:45.973Z", 4334 + "to": "2023-09-27T12:17:45.973Z" 4335 +} 4336 + 4337 +Ответ: 4338 + 4339 +Получаете файл. Сообщение: Code 200/Success 4340 + 4341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4342 +|vehicleId|ID объекта 4343 +|asArchive|true - Архивировать файл, False - не архивировать 4344 +|from|Дата и время начала запроса 4345 +|to|Дата и время окончания запроса 4346 + 4347 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4348 + 4349 +(% class="box infomessage" %) 4350 +((( 4351 +**GET /api/v3/vehicles/export/history/status** 4352 +))) 4353 + 4354 +Метод возвращает список сообщений терминала объекта за выбранный период. 4355 + 4356 +Ответ: 4357 + 4358 +{ 4359 + "activity": true, 4360 + "progress": 0, 4361 + "message": "string" 4362 +} 4363 + 4364 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4365 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4366 +|progress|Прогресс экспорта, от 0 до 100% 4367 +|message|Текст описывающий статус 4368 + 4369 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4370 + 4371 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4372 + 4373 +(% class="box infomessage" %) 4374 +((( 4375 +**POST /api/v3/EcoDriving/rating** 4376 +))) 4377 + 4378 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4379 + 4380 +Тело запроса: 4381 + 4382 +{ 4383 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4384 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4385 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4386 +} 4387 + 4388 +Ответ: 4389 + 4390 +{ 4391 + "items": [ ~/~/ Список в разрезе ТС 4392 + { 4393 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4394 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4395 + "vehicleId": 0, ~/~/ ID ТС 4396 + "vehicleName": "string", ~/~/ Название ТС 4397 + "vehicleModel": "string", ~/~/ Модель ТС 4398 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4399 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4400 + "totalViolations": 0, ~/~/ Нарушений всего 4401 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4402 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4403 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4404 + "brakingViolations": 0, ~/~/ Нарушений торможения 4405 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4406 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4407 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4408 + }, 4409 + 4410 +((( 4411 + 4412 +))) 4413 + 4414 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4415 + "mileage": 0, ~/~/ Пробег, м 4416 + "tripsCount": 0, ~/~/ Кол-во рейсов 4417 + "trips": [ ~/~/ Информация по рейсу 4418 + { 4419 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4420 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4421 + "violationsCount": 0, ~/~/ Всего нарушений 4422 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4423 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4424 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4425 + "brakingViolations": 0, ~/~/ Нарушений торможения 4426 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4427 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4428 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4429 + }, 4430 + 4431 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4432 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4433 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4434 + "mileage": 0, ~/~/ Пробег, м 4435 + "motohours": 0, ~/~/ Моточасы, секунды 4436 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4437 + "startAddress": "string", ~/~/ Адрес начала рейса 4438 + "endAddress": "string", ~/~/ Адрес конца рейса 4439 + "drivers": [ ~/~/ Список водителей 4440 + { 4441 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4442 + "driverName": "string", ~/~/ФИО водителя 4443 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4444 + } 4445 + ] 4446 + } 4447 + ] 4448 + } 4449 + ] 4450 +} 4451 + 4452 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4453 + 4454 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4455 + 4456 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4457 + 4458 +(% class="box infomessage" %) 4459 +((( 4460 +**POST /api/v3/fuelcards/transactions** 4461 +))) 4462 + 4463 +Метод запроса: POST 4464 + 4465 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4466 +\\В заголовках запроса: X-Auth: Токен авторизации 4467 + 4468 +Параметры в теле запроса (JSON): 4469 + 4470 +{ 4471 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4472 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4473 + "ids": [ 4474 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4475 + ], 4476 + "timezone": 0 ~/~/ Часовой пояс 4477 +} 4478 + 4479 + 4480 +Ответ: 4481 + { 4482 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4483 + "driver": "string", ~/~/ Водители, привязанные к ТК 4484 + "object": "string", ~/~/ Наименование ТС 4485 + "amount": 0, ~/~/ Количество топлива 4486 + "amountDut": 0, ~/~/ Количество по ДУТ 4487 + "amountDiff": 0, ~/~/ Разница, л 4488 + "amountDiffPerc": 0, ~/~/ Разница, % 4489 + "summa": 0, ~/~/ Стоимость, руб 4490 + "serviceName": "string", ~/~/ Тип топлива 4491 + "price": 0, ~/~/ Цена за литр, руб 4492 + "cardName": "string", ~/~/ Наименование ТК 4493 + "cardNum": "string", ~/~/ Номер ТК 4494 + "operator": "string", ~/~/ Оператор ТК 4495 + "address": "string" ~/~/ Адрес АЗС 4496 + } 4497 + 4498 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4499 + 4500 +(% class="box infomessage" %) 4501 +((( 4502 +**GET /api/v3/fuelcards** 4503 +))) 4504 + 4505 +Метод запроса: GET 4506 + 4507 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4508 + 4509 +Ответ: 4510 + 4511 +[ 4512 + { 4513 + "Name": "string", ~/~/ Определяет наименование карты. 4514 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4515 + "Number": "string", ~/~/ Определяет № карты. 4516 + "Enabled": true, ~/~/ Определяет признак активности карты. 4517 + "Description": "string", ~/~/ Определяет описание карты. 4518 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4519 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4520 + "deleted": true ~/~/ Признак удаления 4521 + } 4522 +] 4523 + 4524 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4525 + 4526 + 4527 +== **Получение полных данных о ретрансляторе** == 4528 + 4529 +(% class="box infomessage" %) 4530 +((( 4531 +**GET ** **/api/v3/retranslations/{id}** 4532 +))) 4533 + 4534 +id - Идентификатор ретранслятора 4535 + 4536 + 4537 +Пример ответа: 4538 + 4539 +{ 4540 +"description": "", ~/~/ Поле описания ретранслятора 4541 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4542 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4543 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4544 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4545 +"objects": [ ~/~/ Объекты для ретрансляции 4546 +{ 4547 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4548 +"name": "", ~/~/ Наименование объекта ретрансляции 4549 +"imei": "", ~/~/ IMEI объекта ретрансляции 4550 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4551 +} 4552 + ], 4553 +"id": "", ~/~/ Идентификатор ретранслятора 4554 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4555 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4556 +} 4557 + 4558 + 4559 +== **Удаление данных ретранслятора** == 4560 + 4561 +(% class="box infomessage" %) 4562 +((( 4563 +**DELETE** **/api/v3/retranslations/{id}** 4564 +))) 4565 + 4566 +id - Идентификатор ретранслятора 4567 + 4568 + 4569 +== **Создание ретранслятора** == 4570 + 4571 +(% class="box infomessage" %) 4572 +((( 4573 +**POST ** **/api/v3/retranslations/{id}** 4574 +))) 4575 + 4576 +Запрос: 4577 + 4578 +{ 4579 +"description": "", ~/~/ Поле описания ретранслятора 4580 +"subscriberId": "", ~/~/ Идентификатор подписчика 4581 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4582 +"address": "", ~/~/ Адрес и порт принимающего сервера 4583 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4584 +"objects": [ ~/~/Объекты для ретрансляции 4585 +{ 4586 +"id": "", ~/~/ Идентификатор ретранслятора 4587 +"imei": "", ~/~/ IMEI объекта ретрансляции 4588 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4589 +} 4590 + ] 4591 +} 4592 + 4593 + 4594 +Ответ: 4595 + 4596 +{ 4597 +"description": "", ~/~/ Поле описания ретранслятора 4598 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4599 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4600 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4601 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4602 +"objects": [ ~/~/ Объекты для ретрансляции 4603 +{ 4604 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4605 +"name": "string", ~/~/ Наименование объекта ретрансляции 4606 +"imei": "", ~/~/ IMEI объекта ретрансляции 4607 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4608 +} 4609 + ], 4610 +"id": "", ~/~/ Идентификатор ретранслятора 4611 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4612 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4613 +} 4614 + 4615 + 4616 +== **Редактирование ретранслятора** == 4617 + 4618 +(% class="box infomessage" %) 4619 +((( 4620 +**PUT** **/api/v3/retranslations** 4621 +))) 4622 + 4623 +Пример запроса: 4624 + 4625 +{ 4626 +"id": "", ~/~/ Идентификатор ретранслятора 4627 +"description": "string", ~/~/ Поле описания ретранслятора 4628 +"subscriberId": "", ~/~/ Идентификатор подписчика 4629 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4630 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4631 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4632 +"objects": ~/~/ Объекты для ретрансляции 4633 +[ 4634 +{ 4635 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4636 +"imei": "", ~/~/ IMEI объекта ретрансляции 4637 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4638 +} 4639 + ] 4640 +} 4641 + 4642 + 4643 +Пример ответа: 4644 + 4645 +{ 4646 +"description": "", ~/~/ Поле описания ретранслятора 4647 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4648 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4649 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4650 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4651 +"objects": [ ~/~/ Объекты для ретрансляции 4652 +{ 4653 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4654 +"name": "string", ~/~/ Наименование объекта ретрансляции 4655 +"imei": "", ~/~/ IMEI объекта ретрансляции 4656 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4657 +} 4658 + ], 4659 +"id": "", ~/~/ Идентификатор ретранслятора 4660 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4661 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4662 +} 4663 + 4664 + 4665 +== **Получение списка ретранслятора клиента** == 4666 + 4667 +(% class="box infomessage" %) 4668 +((( 4669 +**POST /api/v3/retranslations/find** 4670 +))) 4671 + 4672 +Пример запроса: 4673 + 4674 +{ 4675 +"id": "", ~/~/ Идентификатор ретранслятора 4676 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4677 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4678 +} 4679 + 4680 +Ответ: 4681 + 4682 +[ 4683 +{ 4684 +"description": "", ~/~/ Поле описания ретранслятора 4685 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4686 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4687 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4688 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4689 +"id": "", ~/~/ Идентификатор ретранслятора 4690 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4691 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4692 +} 4693 +] 4694 + 4695 + 4696 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4697 + 4698 +== **API для отчета по выгрузке комбайнов** == 4699 + 4700 +(% class="box infomessage" %) 4701 +((( 4702 +**POST /api/v3/Reports/harvesterUnloading** 4703 +))) 4704 + 4705 +Пример запроса: 4706 + 4707 +{ 4708 + "byTime": 0, ~/~/ Объединение событий по времени 4709 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4710 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4711 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4712 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4713 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4714 + 0 4715 + ], 4716 + "from": "", ~/~/ Дата и время начало запроса 4717 + "to": "", ~/~/ Дата и время окончания запроса 4718 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4719 +} 4720 + 4721 +Пример ответа: 4722 + 4723 +[ 4724 + { 4725 + "harvesterName": "", ~/~/Комбайн, номер 4726 + "harvesterId": 0, ~/~/Комбайн, id 4727 +"harvesterModel": "", ~/~/ Модель комбайна 4728 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4729 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4730 + "events": [ ~/~/Список событий в разрезе комбайна 4731 + { 4732 + "driverId": "", ~/~/Идентификатор водителя 4733 + "driverName": "", ~/~/Водитель комбайна, ФИО 4734 + "RFID": "", ~/~/ идентификатор карты-метки 4735 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4736 + "vehicleId": 0, ~/~/идентификатор объекта 4737 + "vehicleName": "string", ~/~/ Имя объекта 4738 + "modelName": "string", ~/~/ Имя модели объекта 4739 + "nearestVehicles": [ ~/~/Объекты рядом 4740 + { 4741 + "vehicleId": 0, ~/~/идентификатор объекта 4742 + "vehicleName": "string" ~/~/ Имя объекта 4743 + } 4744 + ], 4745 + "fields": [ ~/~/Поля, где происходила выгрузка 4746 + { 4747 + "id": 0, ~/~/ идентификатор пользователя 4748 + "name": "string" ~/~/ имя пользователя 4749 + } 4750 + ], 4751 + "event": "string", ~/~/Событие 4752 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4753 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4754 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4755 + "cultureName": "string", ~/~/ название культуры 4756 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4757 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4758 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4759 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4760 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4761 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4762 + "issued": 0, ~/~/Выдано, бункеров 4763 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4764 + "latitude": 0, ~/~/Широта 4765 + "longitude": 0, ~/~/ Долгота 4766 + "litresAway": 0, ~/~/Отдано, л 4767 + "m3Away": 0 ~/~/Отдано, м3 4768 + } 4769 + ] 4770 + } 4771 +] 4772 + 4773 + 4774 +== **Отчет трек-датчики** == 4775 + 4776 +(% class="box infomessage" %) 4777 +((( 4778 +**POST /api/v3/Reports/sensorsWorks** 4779 +))) 4780 + 4781 +**Пример запроса:** 4782 + 4783 +{ 4784 + "vehicleIds": [ ~/~/ Список ID объектов 4785 + 0 4786 + ], 4787 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4788 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4789 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4790 +} 4791 + 4792 +**Пример ответа:** 4793 + 4794 +((( 4795 +{ 4796 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4797 + { 4798 + "vehicleId": 0, ~/~/ Идентификатор ТС 4799 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4800 + { 4801 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4802 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4803 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4804 + "name": "string", ~/~/ Наименование оборудования. 4805 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4806 + "totalMileage": 0, ~/~/ Общий пробег. 4807 + "avgSpeed": 0 ~/~/ Средняя скорость. 4808 + } 4809 + ] 4810 + } 4811 + ] 4812 +} 4813 +))) 4814 + 4815 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4816 + 4817 + 4818 +== **Запрос списка полей** == 4819 + 4820 +(% class="box successmessage" %) 4821 +((( 4822 +**POST /api/v3/agroLands/find** 4823 +))) 4824 + 4825 +Пример запроса: 4826 + 4827 +((( 4828 +((( 4829 +((( 4830 +{ 4831 + "year": 0, ~/~/ Фильтр по году 4832 + "name": "string", ~/~/ Фильтр по названию 4833 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4834 +} 4835 +))) 4836 +))) 4837 + 4838 + 4839 +))) 4840 + 4841 +Пример ответа: 4842 + 4843 +((( 4844 +[ 4845 + { 4846 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4847 + "year": 0, ~/~/ Год поля 4848 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4849 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4850 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4851 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4852 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4853 + "counts": { ~/~/ Счётчики с/х поля 4854 + "fieldOperations": 0, ~/~/ Количество операций на поле 4855 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4856 + "facts": 0 ~/~/ Счётчик факта 4857 + }, 4858 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4859 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4860 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4861 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4862 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4863 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4864 + "planComment": "string", ~/~/ Комментарий к полю 4865 + "productivity": 0, ~/~/ Урожайность. 4866 + "id": 0, ~/~/ Идентификатор объекта геозоны 4867 + "name": "string", ~/~/ Название объекта геозоны 4868 + "type": 0, ~/~/ Тип объекта геозоны 4869 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4870 + "fname": "string", ~/~/ Имя файла 4871 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4872 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4873 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4874 + "description": "string", ~/~/ Описание объекта геозоны 4875 + "area": 0, ~/~/ Площадь, м2 4876 + "perimetr": 0, ~/~/ Периметр, м 4877 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4878 + } 4879 +] 4880 + 4881 + 4882 +== **Создание нового поля ** == 4883 + 4884 +(% class="box successmessage" %) 4885 +((( 4886 +**POST /api/v3/agroLands** 4887 +))) 4888 + 4889 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4890 +X-agent - ID клиента 4891 + 4892 +Пример запроса: 4893 + 4894 +((( 4895 +{ 4896 + "extId": "string", 4897 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4898 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4899 + "display": "string", ~/~/ Настройки отображения 4900 + "year": 0, ~/~/ Год поля 4901 + "name": "string", ~/~/ Наименование 4902 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4903 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4904 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4905 + "planComment": "string", ~/~/ Комментарий к полю 4906 + "cropRotations": [ ~/~/ Данные по севообороту 4907 + { 4908 + "landId": 0, ~/~/ ID поля 4909 + "landName": "string", ~/~/ Название поля 4910 + "year": 0, ~/~/ Год урожая 4911 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4912 + "cultureName": "string", ~/~/ Название культуры 4913 + "productivity": 0, ~/~/ Урожайность 4914 + "area": 0, ~/~/ Площадь поля, Га 4915 + "total": 0, ~/~/ Валовый сбор 4916 + "productivityFact": 0, ~/~/ Фактическая урожайность 4917 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4918 + "totalFact": 0, ~/~/ Фактический валовый сбор 4919 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4920 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4921 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4922 + "isyearplan": true, ~/~/ Годовой план 4923 + "comment": "string" ~/~/ Комментарий 4924 + } 4925 + ] 4926 +} 4927 +))) 4928 + 4929 +((( 4930 + 4931 +))) 4932 + 4933 +Пример ответа: 4934 + 4935 +((( 4936 +((( 4937 +{ 4938 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4939 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4940 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4941 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4942 + "cropRotations": [ ~/~/ Данные по севообороту 4943 + { 4944 + "landId": 0, ~/~/ ID поля 4945 + "landName": "string", ~/~/ Название поля 4946 + "year": 0, ~/~/ Год урожая 4947 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4948 + "cultureName": "string", ~/~/ Название культуры 4949 + "productivity": 0, ~/~/ Урожайность 4950 + "area": 0, ~/~/ Площадь поля, Га. 4951 + "total": 0, ~/~/ Валовый сбор 4952 + "productivityFact": 0, ~/~/ Фактическая урожайность 4953 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4954 + "totalFact": 0, ~/~/ Фактический валовый сбор 4955 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 4956 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 4957 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 4958 + "isyearplan": true, ~/~/ годовой план 4959 + "comment": "string" ~/~/ Комментарий 4960 + } 4961 + ], 4962 + "cropVegetation": [ ~/~/ История вегетации поля 4963 + { 4964 + "values": [ ~/~/ Данные вегетации и состояния посева 4965 + { 4966 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4967 + "ndvi": 0 ~/~/ Индекс вегетации 4968 + } 4969 + ], 4970 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4971 + { 4972 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4973 + "type": "string", ~/~/ Тип 4974 + "pictureid": "string" ~/~/ Идентификатор ресурса 4975 + } 4976 + ], 4977 + "states": [ ~/~/ Ключевые даты развития поля 4978 + { 4979 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4980 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 4981 + } 4982 + ] 4983 + } 4984 + ], 4985 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 4986 + "counts": { 4987 + "fieldOperations": 0, ~/~/ Количество операций на поле 4988 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4989 + "facts": 0 ~/~/ Счётчик факта 4990 + }, 4991 + "planComment": "string", ~/~/ Комментарий к полю 4992 +))) 4993 + 4994 +((( 4995 + "productivity": 0, ~/~/ Урожайность. 4996 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4997 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 4998 + "year": 0, ~/~/ Год поля 4999 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5000 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5001 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5002 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5003 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5004 + "id": 0, ~/~/ Идентификатор объекта геозоны 5005 + "name": "string", ~/~/ Название объекта геозоны 5006 + "type": 0, ~/~/ Тип объекта геозоны 5007 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5008 + "fname": "string", ~/~/ Имя файла 5009 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5010 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5011 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5012 + "description": "string", ~/~/ Описание объекта геозоны 5013 + "area": 0, ~/~/ Площадь, м2 5014 + "perimetr": 0, ~/~/ Периметр, м 5015 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5016 +} 5017 + 5018 + 5019 +))) 5020 +))) 5021 +))) 5022 + 5023 +== **Получение поля по id** == 5024 + 5025 +(% class="box infomessage" %) 5026 +((( 5027 +**GET /api/v3/agroLands/{id}** 5028 +))) 5029 + 5030 +Пример запроса: 5031 +id ~/~/ Идентификатор поля 5032 + 5033 +Пример ответа: 5034 + 5035 +((( 5036 +{ 5037 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5038 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5039 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5040 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5041 + "cropRotations": [ ~/~/ Данные по севообороту 5042 + { 5043 + "landId": 0, ~/~/ ID поля 5044 + "landName": "string", ~/~/ Название поля 5045 + "year": 0, ~/~/ Год урожая 5046 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5047 + "cultureName": "string", ~/~/ Название культуры 5048 + "productivity": 0, ~/~/ Урожайность 5049 + "area": 0, ~/~/ Площадь поля, Га 5050 + "total": 0, ~/~/ Валовый сбор 5051 + "productivityFact": 0, ~/~/ Фактическая урожайность 5052 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5053 + "totalFact": 0, ~/~/ Фактический валовый сбор 5054 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5055 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5056 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5057 + "isyearplan": true, ~/~/ План года 5058 + "comment": "string" ~/~/ Комментарий 5059 + } 5060 + ], 5061 + "cropVegetation": [ ~/~/ История вегетации поля 5062 + { 5063 + "values": [ ~/~/ Данные вегетации и состояния посева 5064 + { 5065 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5066 + "ndvi": 0 ~/~/ Индекс вегетации 5067 + } 5068 + ], 5069 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5070 + { 5071 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5072 + "type": "string", ~/~/ Тип 5073 + "pictureid": "string" ~/~/ Идентификатор ресурса 5074 + } 5075 + ], 5076 + "states": [ ~/~/ Ключевые даты развития поля 5077 + { 5078 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5079 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5080 + } 5081 + ] 5082 + } 5083 + ], 5084 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5085 + "counts": { 5086 + "fieldOperations": 0, ~/~/ Количество операций на поле 5087 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5088 + "facts": 0 ~/~/ Счётчик факта 5089 + }, 5090 + "planComment": "string", ~/~/ Комментарий к полю 5091 + "productivity": 0, ~/~/ Урожайность. 5092 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5093 +))) 5094 + 5095 +((( 5096 +((( 5097 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5098 + "year": 0, ~/~/ Год поля 5099 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5100 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5101 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5102 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5103 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5104 + "id": 0, ~/~/ Идентификатор объекта геозоны 5105 + "name": "string", ~/~/ Название объекта геозоны 5106 + "type": 0, ~/~/ Тип объекта геозоны 5107 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5108 + "fname": "string", ~/~/ Имя файла 5109 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5110 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5111 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5112 + "description": "string", ~/~/ Описание объекта геозоны 5113 + "area": 0, ~/~/ Площадь, м2 5114 + "perimetr": 0, ~/~/ Периметр, м 5115 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5116 +} 5117 +))) 5118 + 5119 + 5120 +== **Удаление существующего поля** == 5121 + 5122 +(% class="box errormessage" %) 5123 +((( 5124 +**DELETE /api/v3/agroLands/{id}** 5125 +))) 5126 + 5127 +Пример запроса: 5128 +id ~/~/ Идентификатор поля 5129 + 5130 +Пример ответа: 5131 + 5132 +((( 5133 +200 ~/~/ Успех 5134 +))) 5135 + 5136 +((( 5137 + 5138 +))) 5139 + 5140 +((( 5141 +((( 5142 +((( 5143 + 5144 +))) 5145 + 5146 +((( 5147 +== **Изменение поля** == 5148 + 5149 +(% class="box infomessage" %) 5150 +((( 5151 +**PUT /api/v3/agroLands** 5152 +))) 5153 + 5154 +Пример запроса: 5155 + 5156 +((( 5157 +((( 5158 +{ 5159 + "id": 0, ~/~/ Идентификатор поля 5160 + "extId": "string", ~/~/ ExtId 5161 + "shape": "string", ~/~/ Форма поля 5162 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5163 + "display": "string", ~/~/ Настройки отображения 5164 + "year": 0, ~/~/ Год поля 5165 + "name": "string", ~/~/ Наименование 5166 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5167 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5168 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5169 + "planComment": "string", ~/~/Комментарий к полю 5170 + "cropRotations": [ ~/~/ Данные по севообороту 5171 + { 5172 + "landId": 0, ~/~/ ID поля 5173 + "landName": "string", ~/~/ Название поля 5174 + "year": 0, ~/~/ Год урожая 5175 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5176 + "cultureName": "string", ~/~/ Название культуры 5177 + "productivity": 0, ~/~/ Урожайность 5178 + "area": 0, ~/~/ Площадь поля, Га. 5179 + "total": 0, ~/~/ Валовый сбор 5180 + "productivityFact": 0, ~/~/ Фактическая урожайность 5181 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5182 + "totalFact": 0, ~/~/ Фактический валовый сбор 5183 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5184 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5185 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5186 + "isyearplan": true, 5187 + "comment": "string" ~/~/ Комментарий 5188 + } 5189 + ], 5190 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5191 +} 5192 +))) 5193 +))) 5194 + 5195 +((( 5196 + 5197 +))) 5198 + 5199 +Пример ответа: 5200 + 5201 +((( 5202 +((( 5203 +((( 5204 +{ 5205 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5206 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5207 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5208 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5209 + "cropRotations": [ ~/~/ Данные по севообороту 5210 + { 5211 + "landId": 0, ~/~/ ID поля 5212 + "landName": "string", ~/~/ Название поля 5213 + "year": 0, ~/~/ Год урожая 5214 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5215 + "cultureName": "string", ~/~/ Название культуры 5216 + "productivity": 0, ~/~/ Урожайность 5217 + "area": 0, ~/~/ Площадь поля, Га 5218 + "total": 0, ~/~/ Валовый сбор 5219 + "productivityFact": 0, ~/~/ Фактическая урожайность 5220 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5221 + "totalFact": 0, ~/~/ Фактический валовый сбор 5222 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5223 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5224 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5225 + "isyearplan": true, ~/~/ 5226 + "comment": "string" ~/~/ Комментарий 5227 + } 5228 + ], 5229 + "cropVegetation": [ ~/~/ История вегетации поля 5230 + { 5231 + "values": [ ~/~/ Данные вегетации и состояния посева 5232 + { 5233 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5234 + "ndvi": 0 ~/~/ Индекс вегетации 5235 + } 5236 + ], 5237 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5238 + { 5239 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5240 + "type": "string", ~/~/ Тип 5241 + "pictureid": "string" ~/~/ Идентификатор ресурса 5242 + } 5243 + ], 5244 + "states": [ ~/~/ Ключевые даты развития поля 5245 + { 5246 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5247 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5248 + } 5249 + ] 5250 + } 5251 + ], 5252 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5253 + "counts": { 5254 + "fieldOperations": 0, ~/~/ Количество операций на поле 5255 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5256 + "facts": 0 ~/~/ Счётчик факта 5257 + }, 5258 + "planComment": "string", ~/~/ Комментарий к полю 5259 + "productivity": 0, ~/~/ Урожайность. 5260 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5261 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5262 + "year": 0, ~/~/ Год поля 5263 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5264 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5265 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5266 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5267 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5268 + "id": 0, ~/~/ Идентификатор объекта геозоны 5269 + "name": "string", ~/~/ Название объекта геозоны 5270 + "type": 0, ~/~/ Тип объекта геозоны 5271 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5272 + "fname": "string", ~/~/ Имя файла 5273 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5274 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5275 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5276 + "description": "string", ~/~/ Описание объекта геозоны 5277 + "area": 0, ~/~/ Площадь, м2 5278 + "perimetr": 0, ~/~/ Периметр, м 5279 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5280 +} 5281 +))) 5282 +))) 5283 +))) 5284 +))) 5285 +))) 5286 + 5287 + 5288 +== **Редактирование года урожая ** == 5289 + 5290 +(% class="box successmessage" %) 5291 +((( 5292 +**POST /api/v3/agroLands/updateOpenCloseYear** 5293 +))) 5294 + 5295 +Пример запроса: 5296 + 5297 +((( 5298 +((( 5299 +{ 5300 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5301 + 0 5302 + ], 5303 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5304 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5305 +} 5306 +))) 5307 + 5308 + 5309 +))) 5310 + 5311 +Пример ответа: 5312 + 5313 +((( 5314 +((( 5315 +{ 5316 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5317 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5318 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5319 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5320 + "cropRotations": [ ~/~/ Данные по севообороту 5321 + { 5322 + "landId": 0, ~/~/ ID поля 5323 + "landName": "string", ~/~/ Название поля 5324 + "year": 0, ~/~/ Год урожая 5325 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5326 + "cultureName": "string", ~/~/ Название культуры 5327 + "productivity": 0, ~/~/ Урожайность 5328 + "area": 0, ~/~/ Площадь поля, Га. 5329 + "total": 0, ~/~/ Валовый сбор 5330 + "productivityFact": 0, ~/~/ Фактическая урожайность 5331 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5332 + "totalFact": 0, ~/~/ Фактический валовый сбор 5333 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5334 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5335 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5336 + "isyearplan": true, ~/~/ 5337 + "comment": "string" ~/~/ Комментарий 5338 + } 5339 + ], 5340 + "cropVegetation": [ ~/~/ История вегетации поля 5341 + { 5342 + "values": [ ~/~/ Данные вегетации и состояния посева 5343 + { 5344 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5345 + "ndvi": 0 ~/~/ Индекс вегетации 5346 + } 5347 + ], 5348 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5349 + { 5350 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5351 + "type": "string", ~/~/ Тип 5352 + "pictureid": "string" ~/~/ Идентификатор ресурса 5353 + } 5354 + ], 5355 + "states": [ ~/~/ Ключевые даты развития поля 5356 + { 5357 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5358 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5359 + } 5360 + ] 5361 + } 5362 + ], 5363 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5364 + "counts": { 5365 + "fieldOperations": 0, ~/~/ Количество операций на поле 5366 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5367 + "facts": 0 ~/~/ Счётчик факта 5368 + }, 5369 + "planComment": "string", ~/~/ Комментарий к полю 5370 + "productivity": 0, ~/~/ Урожайность. 5371 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5372 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5373 + "year": 0, ~/~/ Год поля 5374 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5375 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5376 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5377 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5378 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5379 + "id": 0, ~/~/ Идентификатор объекта геозоны 5380 + "name": "string", ~/~/ Название объекта геозоны 5381 + "type": 0, ~/~/ Тип объекта геозоны 5382 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5383 + "fname": "string", ~/~/ Имя файла 5384 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5385 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5386 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5387 + "description": "string", ~/~/ Описание объекта геозоны 5388 + "area": 0, ~/~/ Площадь, м2 5389 + "perimetr": 0, ~/~/ ериметр, м 5390 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5391 +} 5392 +))) 5393 + 5394 + 5395 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5396 +))) 5397 +))) 5398 +))) 5399 + 5400 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5401 + 5402 + 5403 +(% class="box infomessage" %) 5404 +((( 5405 +**GET api/v3/Vehicles/recyclebin/all** 5406 +))) 5407 + 5408 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5409 + 5410 +Параметр запроса: {parentId} - идентификатор агента 5411 + 5412 +В заголовках запроса: X-Auth: Токен авторизации 5413 + 5414 +Ответ: 5415 + 5416 +[ 5417 + { 5418 + "recordTime": "", ~/~/Время записи 5419 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5420 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5421 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5422 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5423 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5424 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5425 + "items": [ ~/~/ 5426 +nullable: true ~/~/Детали 5427 + { 5428 + "name": "string", ~/~/наименование столбца 5429 + "value": "string" ~/~/содержание столбца 5430 + } 5431 + ] 5432 + }, 5433 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5434 + "string" 5435 + ] 5436 + } 5437 +] 5438 + 5439 + 5440 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5441 + 5442 +(% class="box infomessage" %) 5443 +((( 5444 +**POST api/v3/Vehicles/recyclebin/erase** 5445 +))) 5446 + 5447 +В заголовках запроса: X-Auth: Токен авторизации 5448 + 5449 +Пример запроса: 5450 + 5451 +[ 5452 +0 5453 +] 5454 + 5455 + 5456 +Пример ответа: 5457 + 5458 +[ 5459 +{ 5460 + "recordTime": "", ~/~/Время записи 5461 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5462 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5463 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5464 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5465 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5466 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5467 + "items": [ ~/~/Детали 5468 + { 5469 + "name": "", ~/~/Имя свойства 5470 + "value": "" ~/~/Значение свойства 5471 + } 5472 + ] 5473 + }, 5474 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5475 + "" 5476 + ] 5477 + } 5478 +] 5479 + 5480 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5481 + 5482 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5483 + 5484 +(% class="box infomessage" %) 5485 +((( 5486 +**POST api/v3/Vehicles/recyclebin/restore** 5487 +))) 5488 + 5489 +В заголовках запроса: X-Auth: Токен авторизации 5490 + 5491 +Параметры в теле запроса (JSON): 5492 + 5493 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5494 + 5495 +В заголовках запроса: X-Auth: Токен авторизации 5496 + 5497 + 5498 +Пример запроса: 5499 + 5500 +((( 5501 +[ 5502 +))) 5503 + 5504 +((( 5505 + 0 5506 +))) 5507 + 5508 +((( 5509 +] 5510 +))) 5511 + 5512 + 5513 +Пример ответа: 5514 + 5515 +[ 5516 +{ 5517 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5518 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5519 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5520 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5521 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5522 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5523 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5524 + "items": [ ~/~/Детали 5525 + { 5526 + "name": "string", ~/~/Имя свойства 5527 + "value": "string" ~/~/Значение свойства 5528 + } 5529 + ] 5530 + }, 5531 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5532 + "string" 5533 + ] 5534 + } 5535 +] 5536 + 5537 + 5538 += **Раздел: Журнал заданий ** = 5539 + 5540 + 5541 +== **Создание задания в Журнале заданий** == 5542 + 5543 +(% class="box infomessage" %) 5544 +((( 5545 +**POST /api/v3/vehicletasks** 5546 +))) 5547 + 5548 +Пример запроса: 5549 + 5550 +((( 5551 +{ 5552 + "vehicleId": 0, ~/~/ Идентификатор ТС 5553 + "description": "string", ~/~/ Описание 5554 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5555 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5556 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5557 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5558 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5559 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5560 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5561 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5562 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5563 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5564 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5565 + "cost": { 5566 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5567 + "Name": "string", ~/~/ Наименование 5568 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5569 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5570 + "Norm": 0 ~/~/ Норма внесения 5571 + }, 5572 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5573 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5574 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5575 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5576 + "deleted": true, ~/~/ Признак удаления 5577 + "extId": "string", 5578 + "GeoIds": [ ~/~/ Cвязанные поля 5579 + 0 5580 + ] 5581 +} 5582 +))) 5583 + 5584 + 5585 +Пример ответа: 5586 + 5587 +{ 5588 + "vehicleId": 0, ~/~/ Идентификатор ТС 5589 + "description": "string", ~/~/ Описание 5590 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5591 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5592 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5593 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5594 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5595 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5596 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5597 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5598 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5599 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5600 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5601 + "cost": { 5602 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5603 + "Name": "string", ~/~/ Наименование 5604 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5605 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5606 + "Norm": 0 ~/~/ Норма внесения 5607 + }, 5608 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5609 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5610 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5611 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5612 + "deleted": true, ~/~/ Признак удаления 5613 + "extId": "string", ~/~/ ExtId 5614 + "GeoIds": [ ~/~/ Связанные поля 5615 + 0 5616 + ] 5617 +} 5618 + 5619 + 5620 +== **Редактирование задания в Журнале заданий** == 5621 + 5622 +(% class="box successmessage" %) 5623 +((( 5624 +**PUT /api/v3/vehicletasks** 5625 +))) 5626 + 5627 +Пример запроса: 5628 + 5629 +((( 5630 +{ 5631 + "vehicleId": 0, ~/~/ Идентификатор ТС 5632 + "description": "string", ~/~/ Описание 5633 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5634 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5635 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5636 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5637 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5638 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5639 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5640 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5641 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5642 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5643 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5644 + "cost": { 5645 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5646 + "Name": "string", ~/~/ Наименование 5647 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5648 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5649 + "Norm": 0 ~/~/ Норма внесения 5650 + }, 5651 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5652 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5653 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5654 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5655 + "deleted": true, ~/~/ Признак удаления 5656 + "extId": "string", ~/~/ ExtId 5657 + "GeoIds": [ ~/~/ Связанные поля 5658 + 0 5659 + ] 5660 +} 5661 +))) 5662 + 5663 + 5664 +Пример ответа: 5665 + 5666 +{ 5667 + "vehicleId": 0, ~/~/ Идентификатор ТС 5668 + "description": "string", ~/~/ Описание 5669 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5670 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5671 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5672 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5673 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5674 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5675 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5676 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5677 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5678 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5679 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5680 + "cost": { 5681 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5682 + "Name": "string", ~/~/ Наименование 5683 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5684 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5685 + "Norm": 0 ~/~/ Норма внесения 5686 + }, 5687 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5688 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5689 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5690 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5691 + "deleted": true, ~/~/ Признак удаления 5692 + "extId": "string", ~/~/ ExtId 5693 + "GeoIds": [ ~/~/ Связанные поля 5694 + 0 5695 + ] 5696 +} 5697 + 5698 + 5699 +== **Удаление задания в Журнале заданий** == 5700 + 5701 +(% class="box warningmessage" %) 5702 +((( 5703 +**DELETE /api/v3/vehicletasks** 5704 +))) 5705 + 5706 +Пример запроса: 5707 + 5708 +((( 5709 +[ 5710 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5711 +] 5712 +))) 5713 + 5714 +((( 5715 + 5716 +))) 5717 + 5718 +Пример ответа: 5719 + 5720 +{ 5721 + "vehicleId": 0, ~/~/ Идентификатор ТС 5722 + "description": "string", ~/~/ Описание 5723 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5724 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5725 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5726 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5727 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5728 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5729 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5730 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5731 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5732 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5733 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5734 + "cost": { 5735 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5736 + "Name": "string", ~/~/ Наименование 5737 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5738 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5739 + "Norm": 0 ~/~/ Норма внесения 5740 + }, 5741 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5742 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5743 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5744 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5745 + "deleted": true, ~/~/ Признак удаления 5746 + "extId": "string", ~/~/ ExtId 5747 + "GeoIds": [ ~/~/ Связанные поля 5748 + 0 5749 + ] 5750 +} 5751 + 5752 + 5753 +== **Получение списка Журнала заданий** == 5754 + 5755 +(% class="box infomessage" %) 5756 +((( 5757 +**POST /api/v3/vehicletasks/getbyperiod** 5758 +))) 5759 + 5760 +Пример запроса: 5761 + 5762 +((( 5763 +{ 5764 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5765 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5766 + "TimeZone": 0, ~/~/ Часовой пояс. 5767 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5768 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5769 + ], 5770 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5771 + 0 5772 + ], 5773 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5774 + 0 5775 + ], 5776 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5777 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5778 +} 5779 +))) 5780 + 5781 + 5782 +Пример ответа: 5783 + 5784 +((( 5785 +{ 5786 + "total": 0, ~/~/ Общее количество записей 5787 + "pages": 0, ~/~/ Общее количество страниц 5788 + "currentPage": 0, ~/~/ Текущая страница 5789 + "items": [ ~/~/ Записи 5790 + { 5791 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5792 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5793 + "name": "string", ~/~/ Название задания. 5794 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5795 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5796 + "workKind": "string", ~/~/ Вид работ 5797 + "techOp": "string", ~/~/ Тех. операция 5798 + "trailerModel": "string", ~/~/ Модель агрегата 5799 + "width": "string", ~/~/ Ширина, м 5800 + "speed": "string", ~/~/ Тех. скорость 5801 + "fields": "string", ~/~/ Поля 5802 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5803 + "vehicles": "string", ~/~/ Объект-модель 5804 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5805 + "drivers": "string", ~/~/ Водители 5806 + "tmc": "string", ~/~/ ТМЦ 5807 + "client": "string", ~/~/ Клиент 5808 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5809 + "dep": "string", ~/~/ Подразделение 5810 + "geoIds": [ ~/~/ Связанные поля 5811 + 0 5812 + ] 5813 + } 5814 + ] 5815 +} 5816 +))) 5817 + 5818 + 5819 += **Раздел: Локатор ** = 5820 + 5821 + 5822 +== **Получение списка локаторов, доступных пользователю ** == 5823 + 5824 +(% class="box infomessage" %) 5825 +((( 5826 +**GET /api/v3/locators** 5827 +))) 5828 + 5829 +В заголовках запроса: X-Auth: Токен авторизации 5830 + 5831 + 5832 +Пример ответа: 5833 + 5834 +((( 5835 +[ 5836 + { 5837 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5838 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5839 + "agentName": "string", ~/~/ Наименование агента. 5840 + "isEnabled": true, ~/~/ Активен 5841 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5842 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5843 + "name": "string", ~/~/ Наименование 5844 + "status": 0, ~/~/ 5845 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5846 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5847 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5848 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5849 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5850 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5851 + "url": "string", ~/~/ Ссылка 5852 + "language": 0, ~/~/ Язык. 5853 + "vehiclesCount": 0, ~/~/ Количество объектов. 5854 + "geozonesCount": 0, ~/~/ Количество геозон. 5855 + "fieldsCount": 0 ~/~/ Количество полей. 5856 + } 5857 +] 5858 +))) 5859 + 5860 + 5861 + 5862 +== **Создание локатора** == 5863 + 5864 +(% class="box successmessage" %) 5865 +((( 5866 +**POST /api/v3/locators** 5867 +))) 5868 + 5869 +Пример запроса: 5870 + 5871 +((( 5872 +{ 5873 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5874 + "isEnabled": true, ~/~/ Активность 5875 + "name": "string", ~/~/ Наименование локатора 5876 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5877 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5878 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5879 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5880 + "url": "string", ~/~/ Ссылка 5881 + "language": 0 ~/~/ Язык 5882 +} 5883 +))) 5884 + 5885 + 5886 +Пример ответа: 5887 + 5888 +((( 5889 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5890 +))) 5891 + 5892 + 5893 + 5894 +== **Изменение локатора** == 5895 + 5896 +(% class="box infomessage" %) 5897 +((( 5898 +**PUT /api/v3/locators** 5899 +))) 5900 + 5901 +Пример запроса: 5902 + 5903 +((( 5904 +{ 5905 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5906 + "isEnabled": true, ~/~/ Активность 5907 + "name": "string", ~/~/ Наименование 5908 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 5909 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5910 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5911 + "autoProlongation": true, ~/~/ Автопродление срока действия 5912 + "url": "string", ~/~/ Ссылка 5913 + "language": 0 ~/~/ Язык 5914 +} 5915 +))) 5916 + 5917 + 5918 +Пример ответа: 5919 + 5920 +200 ~/~/ Success 5921 + 5922 + 5923 +== **Удалить локатор** == 5924 + 5925 +(% class="box warningmessage" %) 5926 +((( 5927 +**DELETE /api/v3/locators** 5928 +))) 5929 + 5930 +Пример запроса: 5931 + 5932 +((( 5933 +[ 5934 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 5935 +] 5936 +))) 5937 + 5938 + 5939 + 5940 + 3371 3371 (% class="box" lang="en-US" style="text-align: center;" %) 3372 3372 ((( 3373 3373 (% 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]] **