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 } ... ... @@ -1984,6 +1984,12 @@ 1984 1984 } 1985 1985 ] 1986 1986 2525 +(% class="box warningmessage" %) 2526 +((( 2527 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2528 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2529 +))) 2530 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2576 + 2577 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2578 + 2579 +(% class="box infomessage" %) 2580 +((( 2581 +**POST /api/v3/vehicles/moveStop** 2582 +))) 2583 + 2584 +Метод запроса: **POST** 2585 + 2586 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2587 + 2588 +В заголовках запроса: X-Auth: Токен авторизации 2589 + 2590 + 2591 +Тело запроса: 2592 + 2593 +{ 2594 + "vehicleIds": [ ], ~/~/ Список ID объектов 2595 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2596 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2597 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2598 +} 2599 + 2600 +Ответ: 2601 + 2602 +[ 2603 + { 2604 + "vehicleId": 0, ~/~/ ID объекта 2605 + "vehicleName": "string", ~/~/ Имя объекта 2606 + "moves": [ ~/~/ Событие движения 2607 + { 2608 + "mileage": 0, ~/~/ Пробег, км 2609 + "eventId": 0, ~/~/ Идентификатор события 2610 + "eventName": "string", ~/~/ Название события 2611 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2612 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2613 + "duration": 0 ~/~/ Продолжительность события, секунд 2614 + } 2615 + ], 2616 + "stops": [ ~/~/ События стоянок 2617 + { 2618 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2619 + "eventId": 0, ~/~/ Идентификатор события 2620 + "eventName": "string", ~/~/ Название события 2621 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2622 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2623 + "duration": 0 ~/~/ Продолжительность события, секунд 2624 + } 2625 + ] 2626 + } 2627 +] 2628 + 2629 + 2630 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2631 + 2632 +(% class="box infomessage" %) 2633 +((( 2634 +**POST /api/v3/vehicles/getlastdata** 2635 +))) 2636 + 2637 +Метод запроса: **POST** 2638 + 2639 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2640 + 2641 +В заголовках запроса: X-Auth: Токен авторизации 2642 + 2643 + 2644 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2645 + 2646 +Ответ: 2647 + { 2648 + "vehicleId": 0, ~/~/Идентификатор объекта. 2649 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2650 + "vehicleNumber": "string",~/~/Номер объекта. 2651 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2652 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2653 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2654 + "speed": 0,~/~/Скорость объекта. 2655 + "course": 0,~/~/Курс движения [0;360] 2656 + "latitude": 0,~/~/Широта [-90°;90°]. 2657 + "longitude": 0,~/~/Долгота [-180°;180°]. 2658 + "address": "string",~/~/Адрес. 2659 + "geozones": [ ~/~/Сведения по геозонам. 2660 + { 2661 + "id": 0, 2662 + "name": "string" 2663 + } 2664 + 2665 + 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 2973 + 2974 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2975 + 2976 +(% class="box warningmessage" %) 2977 +((( 2978 +**PUT** /api/v3/notifications/prolongation 2979 +))) 2980 + 2981 +Метод позволяет продлить уведомления. 2982 + 2983 +Метод запроса **PUT** 2984 + 2985 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2986 + 2987 +В заголовках запроса: X-Auth: Токен авторизации. 2988 + 2989 +Тело запроса: 2990 + 2991 +[ 2992 + 2993 +0 2994 + 2995 +] 2996 + 2997 +где 0 идентификатор ids. 2998 + 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 3590 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3591 + 3592 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3593 + 3594 +(% class="box infomessage" %) 3595 +((( 3596 +**POST /api/v3/Trailers** 3597 +))) 3598 + 3599 +Пример запроса: 3600 + 3601 +{ 3602 + "startDate": "2023-11-14T10:48:03.671Z", 3603 + "endDate": "2023-11-14T10:48:03.671Z", 3604 + "ids": [ 0 ], 3605 + "timezone": 0 3606 +} 3607 + 3608 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3609 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3610 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3611 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3612 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3613 + 3614 +Пример ответа: 3615 + 3616 +[ 3617 + { 3618 + "SD": "2023-11-14T10:48:03.717Z", 3619 + "ED": "2023-11-14T10:48:03.717Z", 3620 + "id": 0, 3621 + "SLat": 0, 3622 + "SLon": 0, 3623 + "ELat": 0, 3624 + "ELon": 0, 3625 + "mileage": 0 3626 + "Duration": 0 3627 + "Address": "string", 3628 + "Address2": "string", 3629 + "name": "string", 3630 + "rid": "string", 3631 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3632 + "trailer": { 3633 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3634 + "Number": "string", 3635 + "Description": "string", 3636 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3637 + "ExternalID": "string", 3638 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3639 + "CreateTime": "2023-11-14T10:48:03.717Z", 3640 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3641 + "IsDeleted": true 3642 + }, 3643 + "filesCount": 0, 3644 + } 3645 +] 3646 + 3647 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3648 +|SD|Дата и время начала события 3649 +|ED|Дата и время окончания события 3650 +|id|ID объекта 3651 +|SLat|Широта начальной координаты 3652 +|SLon|Долгота начальной координаты 3653 +|ELat|Широта конечной координаты 3654 +|ELon|Долгота конечной координаты 3655 +|mileage|Пробег 3656 +|Duration|Продолжительность 3657 +|Address|Адрес начального местоположения 3658 +|Address2|Адрес конечного местоположения 3659 +|name|Имя радиометки 3660 +|rid|Номер радиометки 3661 +|rguid|ID радиометки 3662 +|trailer|Информация об агрегате 3663 +|ModelGuid|ID агрегата 3664 +|Number|Название/номер агрегата 3665 +|Description|Текст примечания агрегата 3666 + 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, ~/~/ Частота трансляции радиометки3688 + "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 3694 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3695 +|parentId|ID клиента 3696 +|name|Название карты-метки 3697 +|number|Номер 3698 +|period|Период запросов в секундах (работает только для агрегатов) 3699 +|id|ID карты-метки 3700 + 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, ~/~/ Частота трансляции радиометки3716 + "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 3722 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3723 +|name|Название карты-метки 3724 +|number|Номер 3725 +|period|Период запросов в секундах (работает только для агрегатов) 3726 +|id|ID карты-метки 3727 +|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 3755 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3756 +|name|Название карты-метки 3757 +|number|Номер 3758 +|period|Период запросов в секундах (работает только для агрегатов) 3759 +|id|ID карты-метки 3760 +|parentId|ID клиента 3761 + 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 3789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3790 +|name|Название карты-метки 3791 +|number|Номер 3792 +|period|Период запросов в секундах (работает только для агрегатов) 3793 +|id|ID карты-метки 3794 +|parentId|ID клиента 3795 + 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 - идентификатор карты-метки 3803 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3283,6 +3283,8 @@ 3283 3283 **PUT /api/v3/Billing/client/balance** 3284 3284 ))) 3285 3285 4044 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4045 + 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 4059 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4060 + 4061 +(% class="box warningmessage" %) 4062 +((( 4063 +**PUT /api/v3/billing/client/balance/deposit** 4064 +))) 4065 + 4066 +Создает операцию **Пополнение **с указанной суммой 4067 + 4068 +Тело запроса: 4069 + 4070 +{ 4071 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4072 + "Balance": 0 4073 +} 4074 + 4075 +Ответ: Success 4076 + 4077 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4078 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4079 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4080 + 4081 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4082 + 4083 +Создает операцию **Списание **с указанной суммой 4084 + 4085 +(% class="box warningmessage" %) 4086 +((( 4087 +**PUT /api/v3/billing/client/balance/withdraw** 4088 +))) 4089 + 4090 +Тело запроса: 4091 + 4092 +{ 4093 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4094 + "Balance": 0 4095 +} 4096 + 4097 +Ответ: Success 4098 + 4099 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4100 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4101 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4102 + 3299 3299 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3300 3300 3301 3301 (% class="box warningmessage" %) ... ... @@ -3358,6 +3358,7 @@ 3358 3358 3359 3359 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3360 3360 |ClientId|Идентификатор клиента 4165 +|PlanId|Идентификатор тарифного плана 3361 3361 |Feature|Код услуги 3362 3362 |IsEnabled|Признак, определяющий активирована ли услуга 3363 3363 |IsFactual|Признак, определяющий расчёт по факту ... ... @@ -3367,6 +3367,1769 @@ 3367 3367 |PeriodValue|Значение периода. 3368 3368 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3369 3369 4175 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4176 + 4177 +(% class="box warningmessage" %) 4178 +((( 4179 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4180 +))) 4181 + 4182 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4183 + 4184 +(% class="box infomessage" %) 4185 +((( 4186 +**POST /api/v3/vehicles/import/{agentId}** 4187 +))) 4188 + 4189 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4190 + 4191 +В пути указывается **agentId** - id клиента. 4192 + 4193 +**Заголовок** 4194 + 4195 +**X-Auth: [токен авторизации]** 4196 + 4197 +**Параметры** 4198 + 4199 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4200 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4201 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4202 + 4203 +В теле использовать тип **form-data,** тип значения** file** 4204 + 4205 +**Ключи** 4206 + 4207 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4208 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4209 +|csv|В значении передаем файл датчиков, формат **csv** 4210 + 4211 +Ответ: 4212 + 4213 +{ 4214 + "vehicleId": 0, 4215 + "name": "string", 4216 + "errors": ["string"] 4217 +} 4218 + 4219 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4220 +|vehicleId|ID созданного объекта 4221 +|name|Имя созданного объекта 4222 +|errors|Ошибки и их описание 4223 + 4224 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4225 + 4226 +(% class="box infomessage" %) 4227 +((( 4228 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4229 +))) 4230 + 4231 +(% class="wikigeneratedid" %) 4232 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4233 + 4234 +(% class="wikigeneratedid" %) 4235 +В пути указывается **vehicleId **- id объекта. 4236 + 4237 +**Заголовок** 4238 + 4239 +**X-Auth: [токен авторизации]** 4240 + 4241 +В теле использовать тип **form-data.** 4242 + 4243 +Ключи: 4244 + 4245 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4246 +|**history**|В значении передавать файл с историей 4247 + 4248 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4249 + 4250 +Ответ: 4251 + 4252 +{ 4253 + "results": [ 4254 + { 4255 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4256 + "vehicleId": 0, 4257 + "errors": [ 4258 + "string" 4259 + ], 4260 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4261 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4262 + "producedCount": 0, 4263 + "msgCount": 0 4264 + } 4265 + ] 4266 +} 4267 + 4268 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4269 +|results|Результаты импорта в разрезе ТС 4270 +|vehicleGuid|Guid ТС 4271 +|vehicleId|ID ТС 4272 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4273 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4274 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4275 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4276 +|msgCount|Кол-во обработанных сообщений всего 4277 + 4278 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4279 + 4280 +(% class="box infomessage" %) 4281 +((( 4282 +**GET /api/v3/vehicles/import/history/status** 4283 +))) 4284 + 4285 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4286 + 4287 +Ответ: 4288 + 4289 +{ 4290 + "activity": true, 4291 + "progress": 0, 4292 + "message": "string" 4293 +} 4294 + 4295 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4296 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4297 +|progress|Guid ТС 4298 + 4299 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4300 + 4301 +(% class="box infomessage" %) 4302 +((( 4303 +**POST /api/v3/vehicles/export** 4304 +))) 4305 + 4306 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4307 + 4308 +Тело запроса: 4309 + 4310 +[ 4311 + id 4312 +] 4313 + 4314 +Ответ: Success 200, получаете файлы с настройками. 4315 + 4316 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4317 + 4318 +(% class="box infomessage" %) 4319 +((( 4320 +**POST /api/v3/vehicles/export/history** 4321 +))) 4322 + 4323 +Метод возвращает список сообщений терминала объекта за выбранный период. 4324 + 4325 +Тело запроса: 4326 + 4327 +{ 4328 + "vehicleId": 0, 4329 + "asArchive": true, 4330 + "from": "2023-09-27T12:17:45.973Z", 4331 + "to": "2023-09-27T12:17:45.973Z" 4332 +} 4333 + 4334 +Ответ: 4335 + 4336 +Получаете файл. Сообщение: Code 200/Success 4337 + 4338 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4339 +|vehicleId|ID объекта 4340 +|asArchive|true - Архивировать файл, False - не архивировать 4341 +|from|Дата и время начала запроса 4342 +|to|Дата и время окончания запроса 4343 + 4344 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4345 + 4346 +(% class="box infomessage" %) 4347 +((( 4348 +**GET /api/v3/vehicles/export/history/status** 4349 +))) 4350 + 4351 +Метод возвращает список сообщений терминала объекта за выбранный период. 4352 + 4353 +Ответ: 4354 + 4355 +{ 4356 + "activity": true, 4357 + "progress": 0, 4358 + "message": "string" 4359 +} 4360 + 4361 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4362 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4363 +|progress|Прогресс экспорта, от 0 до 100% 4364 +|message|Текст описывающий статус 4365 + 4366 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4367 + 4368 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4369 + 4370 +(% class="box infomessage" %) 4371 +((( 4372 +**POST /api/v3/EcoDriving/rating** 4373 +))) 4374 + 4375 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4376 + 4377 +Тело запроса: 4378 + 4379 +{ 4380 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4381 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4382 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4383 +} 4384 + 4385 +Ответ: 4386 + 4387 +{ 4388 + "items": [ ~/~/ Список в разрезе ТС 4389 + { 4390 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4391 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4392 + "vehicleId": 0, ~/~/ ID ТС 4393 + "vehicleName": "string", ~/~/ Название ТС 4394 + "vehicleModel": "string", ~/~/ Модель ТС 4395 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4396 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4397 + "totalViolations": 0, ~/~/ Нарушений всего 4398 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4399 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4400 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4401 + "brakingViolations": 0, ~/~/ Нарушений торможения 4402 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4403 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4404 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4405 + }, 4406 + 4407 +((( 4408 + 4409 +))) 4410 + 4411 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4412 + "mileage": 0, ~/~/ Пробег, м 4413 + "tripsCount": 0, ~/~/ Кол-во рейсов 4414 + "trips": [ ~/~/ Информация по рейсу 4415 + { 4416 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4417 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4418 + "violationsCount": 0, ~/~/ Всего нарушений 4419 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4420 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4421 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4422 + "brakingViolations": 0, ~/~/ Нарушений торможения 4423 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4424 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4425 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4426 + }, 4427 + 4428 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4429 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4430 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4431 + "mileage": 0, ~/~/ Пробег, м 4432 + "motohours": 0, ~/~/ Моточасы, секунды 4433 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4434 + "startAddress": "string", ~/~/ Адрес начала рейса 4435 + "endAddress": "string", ~/~/ Адрес конца рейса 4436 + "drivers": [ ~/~/ Список водителей 4437 + { 4438 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4439 + "driverName": "string", ~/~/ФИО водителя 4440 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4441 + } 4442 + ] 4443 + } 4444 + ] 4445 + } 4446 + ] 4447 +} 4448 + 4449 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4450 + 4451 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4452 + 4453 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4454 + 4455 +(% class="box infomessage" %) 4456 +((( 4457 +**POST /api/v3/fuelcards/transactions** 4458 +))) 4459 + 4460 +Метод запроса: POST 4461 + 4462 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4463 +\\В заголовках запроса: X-Auth: Токен авторизации 4464 + 4465 +Параметры в теле запроса (JSON): 4466 + 4467 +{ 4468 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4469 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4470 + "ids": [ 4471 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4472 + ], 4473 + "timezone": 0 ~/~/ Часовой пояс 4474 +} 4475 + 4476 + 4477 +Ответ: 4478 + { 4479 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4480 + "driver": "string", ~/~/ Водители, привязанные к ТК 4481 + "object": "string", ~/~/ Наименование ТС 4482 + "amount": 0, ~/~/ Количество топлива 4483 + "amountDut": 0, ~/~/ Количество по ДУТ 4484 + "amountDiff": 0, ~/~/ Разница, л 4485 + "amountDiffPerc": 0, ~/~/ Разница, % 4486 + "summa": 0, ~/~/ Стоимость, руб 4487 + "serviceName": "string", ~/~/ Тип топлива 4488 + "price": 0, ~/~/ Цена за литр, руб 4489 + "cardName": "string", ~/~/ Наименование ТК 4490 + "cardNum": "string", ~/~/ Номер ТК 4491 + "operator": "string", ~/~/ Оператор ТК 4492 + "address": "string" ~/~/ Адрес АЗС 4493 + } 4494 + 4495 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4496 + 4497 +(% class="box infomessage" %) 4498 +((( 4499 +**GET /api/v3/fuelcards** 4500 +))) 4501 + 4502 +Метод запроса: GET 4503 + 4504 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4505 + 4506 +Ответ: 4507 + 4508 +[ 4509 + { 4510 + "Name": "string", ~/~/ Определяет наименование карты. 4511 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4512 + "Number": "string", ~/~/ Определяет № карты. 4513 + "Enabled": true, ~/~/ Определяет признак активности карты. 4514 + "Description": "string", ~/~/ Определяет описание карты. 4515 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4516 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4517 + "deleted": true ~/~/ Признак удаления 4518 + } 4519 +] 4520 + 4521 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4522 + 4523 + 4524 +== **Получение полных данных о ретрансляторе** == 4525 + 4526 +(% class="box infomessage" %) 4527 +((( 4528 +**GET ** **/api/v3/retranslations/{id}** 4529 +))) 4530 + 4531 +id - Идентификатор ретранслятора 4532 + 4533 + 4534 +Пример ответа: 4535 + 4536 +{ 4537 +"description": "", ~/~/ Поле описания ретранслятора 4538 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4539 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4540 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4541 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4542 +"objects": [ ~/~/ Объекты для ретрансляции 4543 +{ 4544 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4545 +"name": "", ~/~/ Наименование объекта ретрансляции 4546 +"imei": "", ~/~/ IMEI объекта ретрансляции 4547 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4548 +} 4549 + ], 4550 +"id": "", ~/~/ Идентификатор ретранслятора 4551 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4552 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4553 +} 4554 + 4555 + 4556 +== **Удаление данных ретранслятора** == 4557 + 4558 +(% class="box infomessage" %) 4559 +((( 4560 +**DELETE** **/api/v3/retranslations/{id}** 4561 +))) 4562 + 4563 +id - Идентификатор ретранслятора 4564 + 4565 + 4566 +== **Создание ретранслятора** == 4567 + 4568 +(% class="box infomessage" %) 4569 +((( 4570 +**POST ** **/api/v3/retranslations/{id}** 4571 +))) 4572 + 4573 +Запрос: 4574 + 4575 +{ 4576 +"description": "", ~/~/ Поле описания ретранслятора 4577 +"subscriberId": "", ~/~/ Идентификатор подписчика 4578 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4579 +"address": "", ~/~/ Адрес и порт принимающего сервера 4580 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4581 +"objects": [ ~/~/Объекты для ретрансляции 4582 +{ 4583 +"id": "", ~/~/ Идентификатор ретранслятора 4584 +"imei": "", ~/~/ IMEI объекта ретрансляции 4585 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4586 +} 4587 + ] 4588 +} 4589 + 4590 + 4591 +Ответ: 4592 + 4593 +{ 4594 +"description": "", ~/~/ Поле описания ретранслятора 4595 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4596 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4597 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4598 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4599 +"objects": [ ~/~/ Объекты для ретрансляции 4600 +{ 4601 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4602 +"name": "string", ~/~/ Наименование объекта ретрансляции 4603 +"imei": "", ~/~/ IMEI объекта ретрансляции 4604 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4605 +} 4606 + ], 4607 +"id": "", ~/~/ Идентификатор ретранслятора 4608 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4609 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4610 +} 4611 + 4612 + 4613 +== **Редактирование ретранслятора** == 4614 + 4615 +(% class="box infomessage" %) 4616 +((( 4617 +**PUT** **/api/v3/retranslations** 4618 +))) 4619 + 4620 +Пример запроса: 4621 + 4622 +{ 4623 +"id": "", ~/~/ Идентификатор ретранслятора 4624 +"description": "string", ~/~/ Поле описания ретранслятора 4625 +"subscriberId": "", ~/~/ Идентификатор подписчика 4626 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4627 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4628 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4629 +"objects": ~/~/ Объекты для ретрансляции 4630 +[ 4631 +{ 4632 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4633 +"imei": "", ~/~/ IMEI объекта ретрансляции 4634 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4635 +} 4636 + ] 4637 +} 4638 + 4639 + 4640 +Пример ответа: 4641 + 4642 +{ 4643 +"description": "", ~/~/ Поле описания ретранслятора 4644 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4645 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4646 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4647 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4648 +"objects": [ ~/~/ Объекты для ретрансляции 4649 +{ 4650 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4651 +"name": "string", ~/~/ Наименование объекта ретрансляции 4652 +"imei": "", ~/~/ IMEI объекта ретрансляции 4653 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4654 +} 4655 + ], 4656 +"id": "", ~/~/ Идентификатор ретранслятора 4657 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4658 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4659 +} 4660 + 4661 + 4662 +== **Получение списка ретранслятора клиента** == 4663 + 4664 +(% class="box infomessage" %) 4665 +((( 4666 +**POST /api/v3/retranslations/find** 4667 +))) 4668 + 4669 +Пример запроса: 4670 + 4671 +{ 4672 +"id": "", ~/~/ Идентификатор ретранслятора 4673 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4674 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4675 +} 4676 + 4677 +Ответ: 4678 + 4679 +[ 4680 +{ 4681 +"description": "", ~/~/ Поле описания ретранслятора 4682 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4683 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4684 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4685 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4686 +"id": "", ~/~/ Идентификатор ретранслятора 4687 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4688 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4689 +} 4690 +] 4691 + 4692 + 4693 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4694 + 4695 +== **API для отчета по выгрузке комбайнов** == 4696 + 4697 +(% class="box infomessage" %) 4698 +((( 4699 +**POST /api/v3/Reports/harvesterUnloading** 4700 +))) 4701 + 4702 +Пример запроса: 4703 + 4704 +{ 4705 + "byTime": 0, ~/~/ Объединение событий по времени 4706 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4707 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4708 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4709 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4710 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4711 + 0 4712 + ], 4713 + "from": "", ~/~/ Дата и время начало запроса 4714 + "to": "", ~/~/ Дата и время окончания запроса 4715 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4716 +} 4717 + 4718 +Пример ответа: 4719 + 4720 +[ 4721 + { 4722 + "harvesterName": "", ~/~/Комбайн, номер 4723 + "harvesterId": 0, ~/~/Комбайн, id 4724 +"harvesterModel": "", ~/~/ Модель комбайна 4725 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4726 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4727 + "events": [ ~/~/Список событий в разрезе комбайна 4728 + { 4729 + "driverId": "", ~/~/Идентификатор водителя 4730 + "driverName": "", ~/~/Водитель комбайна, ФИО 4731 + "RFID": "", ~/~/ идентификатор карты-метки 4732 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4733 + "vehicleId": 0, ~/~/идентификатор объекта 4734 + "vehicleName": "string", ~/~/ Имя объекта 4735 + "modelName": "string", ~/~/ Имя модели объекта 4736 + "nearestVehicles": [ ~/~/Объекты рядом 4737 + { 4738 + "vehicleId": 0, ~/~/идентификатор объекта 4739 + "vehicleName": "string" ~/~/ Имя объекта 4740 + } 4741 + ], 4742 + "fields": [ ~/~/Поля, где происходила выгрузка 4743 + { 4744 + "id": 0, ~/~/ идентификатор пользователя 4745 + "name": "string" ~/~/ имя пользователя 4746 + } 4747 + ], 4748 + "event": "string", ~/~/Событие 4749 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4750 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4751 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4752 + "cultureName": "string", ~/~/ название культуры 4753 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4754 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4755 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4756 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4757 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4758 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4759 + "issued": 0, ~/~/Выдано, бункеров 4760 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4761 + "latitude": 0, ~/~/Широта 4762 + "longitude": 0, ~/~/ Долгота 4763 + "litresAway": 0, ~/~/Отдано, л 4764 + "m3Away": 0 ~/~/Отдано, м3 4765 + } 4766 + ] 4767 + } 4768 +] 4769 + 4770 + 4771 +== **Отчет трек-датчики** == 4772 + 4773 +(% class="box infomessage" %) 4774 +((( 4775 +**POST /api/v3/Reports/sensorsWorks** 4776 +))) 4777 + 4778 +**Пример запроса:** 4779 + 4780 +{ 4781 + "vehicleIds": [ ~/~/ Список ID объектов 4782 + 0 4783 + ], 4784 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4785 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4786 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4787 +} 4788 + 4789 +**Пример ответа:** 4790 + 4791 +((( 4792 +{ 4793 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4794 + { 4795 + "vehicleId": 0, ~/~/ Идентификатор ТС 4796 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4797 + { 4798 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4799 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4800 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4801 + "name": "string", ~/~/ Наименование оборудования. 4802 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4803 + "totalMileage": 0, ~/~/ Общий пробег. 4804 + "avgSpeed": 0 ~/~/ Средняя скорость. 4805 + } 4806 + ] 4807 + } 4808 + ] 4809 +} 4810 +))) 4811 + 4812 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4813 + 4814 + 4815 +== **Запрос списка полей** == 4816 + 4817 +(% class="box successmessage" %) 4818 +((( 4819 +**POST /api/v3/agroLands/find** 4820 +))) 4821 + 4822 +Пример запроса: 4823 + 4824 +((( 4825 +((( 4826 +((( 4827 +{ 4828 + "year": 0, ~/~/ Фильтр по году 4829 + "name": "string", ~/~/ Фильтр по названию 4830 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4831 +} 4832 +))) 4833 +))) 4834 + 4835 + 4836 +))) 4837 + 4838 +Пример ответа: 4839 + 4840 +((( 4841 +[ 4842 + { 4843 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4844 + "year": 0, ~/~/ Год поля 4845 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4846 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4847 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4848 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4849 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4850 + "counts": { ~/~/ Счётчики с/х поля 4851 + "fieldOperations": 0, ~/~/ Количество операций на поле 4852 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4853 + "facts": 0 ~/~/ Счётчик факта 4854 + }, 4855 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4856 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4857 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4858 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4859 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4860 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4861 + "planComment": "string", ~/~/ Комментарий к полю 4862 + "productivity": 0, ~/~/ Урожайность. 4863 + "id": 0, ~/~/ Идентификатор объекта геозоны 4864 + "name": "string", ~/~/ Название объекта геозоны 4865 + "type": 0, ~/~/ Тип объекта геозоны 4866 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4867 + "fname": "string", ~/~/ Имя файла 4868 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4869 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4870 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4871 + "description": "string", ~/~/ Описание объекта геозоны 4872 + "area": 0, ~/~/ Площадь, м2 4873 + "perimetr": 0, ~/~/ Периметр, м 4874 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4875 + } 4876 +] 4877 + 4878 + 4879 +== **Создание нового поля ** == 4880 + 4881 +(% class="box successmessage" %) 4882 +((( 4883 +**POST /api/v3/agroLands** 4884 +))) 4885 + 4886 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4887 +X-agent - ID клиента 4888 + 4889 +Пример запроса: 4890 + 4891 +((( 4892 +{ 4893 + "extId": "string", 4894 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 4895 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 4896 + "display": "string", ~/~/ Настройки отображения 4897 + "year": 0, ~/~/ Год поля 4898 + "name": "string", ~/~/ Наименование 4899 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4900 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4901 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4902 + "planComment": "string", ~/~/ Комментарий к полю 4903 + "cropRotations": [ ~/~/ Данные по севообороту 4904 + { 4905 + "landId": 0, ~/~/ ID поля 4906 + "landName": "string", ~/~/ Название поля 4907 + "year": 0, ~/~/ Год урожая 4908 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4909 + "cultureName": "string", ~/~/ Название культуры 4910 + "productivity": 0, ~/~/ Урожайность 4911 + "area": 0, ~/~/ Площадь поля, Га 4912 + "total": 0, ~/~/ Валовый сбор 4913 + "productivityFact": 0, ~/~/ Фактическая урожайность 4914 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4915 + "totalFact": 0, ~/~/ Фактический валовый сбор 4916 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4917 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4918 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4919 + "isyearplan": true, ~/~/ Годовой план 4920 + "comment": "string" ~/~/ Комментарий 4921 + } 4922 + ] 4923 +} 4924 +))) 4925 + 4926 +((( 4927 + 4928 +))) 4929 + 4930 +Пример ответа: 4931 + 4932 +((( 4933 +((( 4934 +{ 4935 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4936 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4937 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4938 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4939 + "cropRotations": [ ~/~/ Данные по севообороту 4940 + { 4941 + "landId": 0, ~/~/ ID поля 4942 + "landName": "string", ~/~/ Название поля 4943 + "year": 0, ~/~/ Год урожая 4944 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4945 + "cultureName": "string", ~/~/ Название культуры 4946 + "productivity": 0, ~/~/ Урожайность 4947 + "area": 0, ~/~/ Площадь поля, Га. 4948 + "total": 0, ~/~/ Валовый сбор 4949 + "productivityFact": 0, ~/~/ Фактическая урожайность 4950 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4951 + "totalFact": 0, ~/~/ Фактический валовый сбор 4952 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 4953 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 4954 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 4955 + "isyearplan": true, ~/~/ годовой план 4956 + "comment": "string" ~/~/ Комментарий 4957 + } 4958 + ], 4959 + "cropVegetation": [ ~/~/ История вегетации поля 4960 + { 4961 + "values": [ ~/~/ Данные вегетации и состояния посева 4962 + { 4963 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4964 + "ndvi": 0 ~/~/ Индекс вегетации 4965 + } 4966 + ], 4967 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4968 + { 4969 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4970 + "type": "string", ~/~/ Тип 4971 + "pictureid": "string" ~/~/ Идентификатор ресурса 4972 + } 4973 + ], 4974 + "states": [ ~/~/ Ключевые даты развития поля 4975 + { 4976 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4977 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 4978 + } 4979 + ] 4980 + } 4981 + ], 4982 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 4983 + "counts": { 4984 + "fieldOperations": 0, ~/~/ Количество операций на поле 4985 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4986 + "facts": 0 ~/~/ Счётчик факта 4987 + }, 4988 + "planComment": "string", ~/~/ Комментарий к полю 4989 +))) 4990 + 4991 +((( 4992 + "productivity": 0, ~/~/ Урожайность. 4993 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4994 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 4995 + "year": 0, ~/~/ Год поля 4996 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4997 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4998 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4999 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5000 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5001 + "id": 0, ~/~/ Идентификатор объекта геозоны 5002 + "name": "string", ~/~/ Название объекта геозоны 5003 + "type": 0, ~/~/ Тип объекта геозоны 5004 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5005 + "fname": "string", ~/~/ Имя файла 5006 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5007 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5008 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5009 + "description": "string", ~/~/ Описание объекта геозоны 5010 + "area": 0, ~/~/ Площадь, м2 5011 + "perimetr": 0, ~/~/ Периметр, м 5012 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5013 +} 5014 + 5015 + 5016 +))) 5017 +))) 5018 +))) 5019 + 5020 +== **Получение поля по id** == 5021 + 5022 +(% class="box infomessage" %) 5023 +((( 5024 +**GET /api/v3/agroLands/{id}** 5025 +))) 5026 + 5027 +Пример запроса: 5028 +id ~/~/ Идентификатор поля 5029 + 5030 +Пример ответа: 5031 + 5032 +((( 5033 +{ 5034 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5035 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5036 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5037 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5038 + "cropRotations": [ ~/~/ Данные по севообороту 5039 + { 5040 + "landId": 0, ~/~/ ID поля 5041 + "landName": "string", ~/~/ Название поля 5042 + "year": 0, ~/~/ Год урожая 5043 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5044 + "cultureName": "string", ~/~/ Название культуры 5045 + "productivity": 0, ~/~/ Урожайность 5046 + "area": 0, ~/~/ Площадь поля, Га 5047 + "total": 0, ~/~/ Валовый сбор 5048 + "productivityFact": 0, ~/~/ Фактическая урожайность 5049 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5050 + "totalFact": 0, ~/~/ Фактический валовый сбор 5051 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5052 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5053 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5054 + "isyearplan": true, ~/~/ План года 5055 + "comment": "string" ~/~/ Комментарий 5056 + } 5057 + ], 5058 + "cropVegetation": [ ~/~/ История вегетации поля 5059 + { 5060 + "values": [ ~/~/ Данные вегетации и состояния посева 5061 + { 5062 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5063 + "ndvi": 0 ~/~/ Индекс вегетации 5064 + } 5065 + ], 5066 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5067 + { 5068 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5069 + "type": "string", ~/~/ Тип 5070 + "pictureid": "string" ~/~/ Идентификатор ресурса 5071 + } 5072 + ], 5073 + "states": [ ~/~/ Ключевые даты развития поля 5074 + { 5075 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5076 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5077 + } 5078 + ] 5079 + } 5080 + ], 5081 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5082 + "counts": { 5083 + "fieldOperations": 0, ~/~/ Количество операций на поле 5084 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5085 + "facts": 0 ~/~/ Счётчик факта 5086 + }, 5087 + "planComment": "string", ~/~/ Комментарий к полю 5088 + "productivity": 0, ~/~/ Урожайность. 5089 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5090 +))) 5091 + 5092 +((( 5093 +((( 5094 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5095 + "year": 0, ~/~/ Год поля 5096 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5097 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5098 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5099 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5100 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5101 + "id": 0, ~/~/ Идентификатор объекта геозоны 5102 + "name": "string", ~/~/ Название объекта геозоны 5103 + "type": 0, ~/~/ Тип объекта геозоны 5104 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5105 + "fname": "string", ~/~/ Имя файла 5106 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5107 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5108 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5109 + "description": "string", ~/~/ Описание объекта геозоны 5110 + "area": 0, ~/~/ Площадь, м2 5111 + "perimetr": 0, ~/~/ Периметр, м 5112 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5113 +} 5114 +))) 5115 + 5116 + 5117 +== **Удаление существующего поля** == 5118 + 5119 +(% class="box errormessage" %) 5120 +((( 5121 +**DELETE /api/v3/agroLands/{id}** 5122 +))) 5123 + 5124 +Пример запроса: 5125 +id ~/~/ Идентификатор поля 5126 + 5127 +Пример ответа: 5128 + 5129 +((( 5130 +200 ~/~/ Успех 5131 +))) 5132 + 5133 +((( 5134 + 5135 +))) 5136 + 5137 +((( 5138 +((( 5139 +((( 5140 + 5141 +))) 5142 + 5143 +((( 5144 +== **Изменение поля** == 5145 + 5146 +(% class="box infomessage" %) 5147 +((( 5148 +**PUT /api/v3/agroLands** 5149 +))) 5150 + 5151 +Пример запроса: 5152 + 5153 +((( 5154 +((( 5155 +{ 5156 + "id": 0, ~/~/ Идентификатор поля 5157 + "extId": "string", ~/~/ ExtId 5158 + "shape": "string", ~/~/ Форма поля 5159 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5160 + "display": "string", ~/~/ Настройки отображения 5161 + "year": 0, ~/~/ Год поля 5162 + "name": "string", ~/~/ Наименование 5163 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5164 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5165 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5166 + "planComment": "string", ~/~/Комментарий к полю 5167 + "cropRotations": [ ~/~/ Данные по севообороту 5168 + { 5169 + "landId": 0, ~/~/ ID поля 5170 + "landName": "string", ~/~/ Название поля 5171 + "year": 0, ~/~/ Год урожая 5172 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5173 + "cultureName": "string", ~/~/ Название культуры 5174 + "productivity": 0, ~/~/ Урожайность 5175 + "area": 0, ~/~/ Площадь поля, Га. 5176 + "total": 0, ~/~/ Валовый сбор 5177 + "productivityFact": 0, ~/~/ Фактическая урожайность 5178 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5179 + "totalFact": 0, ~/~/ Фактический валовый сбор 5180 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5181 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5182 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5183 + "isyearplan": true, 5184 + "comment": "string" ~/~/ Комментарий 5185 + } 5186 + ], 5187 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5188 +} 5189 +))) 5190 +))) 5191 + 5192 +((( 5193 + 5194 +))) 5195 + 5196 +Пример ответа: 5197 + 5198 +((( 5199 +((( 5200 +((( 5201 +{ 5202 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5203 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5204 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5205 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5206 + "cropRotations": [ ~/~/ Данные по севообороту 5207 + { 5208 + "landId": 0, ~/~/ ID поля 5209 + "landName": "string", ~/~/ Название поля 5210 + "year": 0, ~/~/ Год урожая 5211 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5212 + "cultureName": "string", ~/~/ Название культуры 5213 + "productivity": 0, ~/~/ Урожайность 5214 + "area": 0, ~/~/ Площадь поля, Га 5215 + "total": 0, ~/~/ Валовый сбор 5216 + "productivityFact": 0, ~/~/ Фактическая урожайность 5217 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5218 + "totalFact": 0, ~/~/ Фактический валовый сбор 5219 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5220 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5221 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5222 + "isyearplan": true, ~/~/ 5223 + "comment": "string" ~/~/ Комментарий 5224 + } 5225 + ], 5226 + "cropVegetation": [ ~/~/ История вегетации поля 5227 + { 5228 + "values": [ ~/~/ Данные вегетации и состояния посева 5229 + { 5230 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5231 + "ndvi": 0 ~/~/ Индекс вегетации 5232 + } 5233 + ], 5234 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5235 + { 5236 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5237 + "type": "string", ~/~/ Тип 5238 + "pictureid": "string" ~/~/ Идентификатор ресурса 5239 + } 5240 + ], 5241 + "states": [ ~/~/ Ключевые даты развития поля 5242 + { 5243 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5244 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5245 + } 5246 + ] 5247 + } 5248 + ], 5249 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5250 + "counts": { 5251 + "fieldOperations": 0, ~/~/ Количество операций на поле 5252 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5253 + "facts": 0 ~/~/ Счётчик факта 5254 + }, 5255 + "planComment": "string", ~/~/ Комментарий к полю 5256 + "productivity": 0, ~/~/ Урожайность. 5257 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5258 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5259 + "year": 0, ~/~/ Год поля 5260 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5261 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5262 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5263 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5264 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5265 + "id": 0, ~/~/ Идентификатор объекта геозоны 5266 + "name": "string", ~/~/ Название объекта геозоны 5267 + "type": 0, ~/~/ Тип объекта геозоны 5268 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5269 + "fname": "string", ~/~/ Имя файла 5270 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5271 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5272 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5273 + "description": "string", ~/~/ Описание объекта геозоны 5274 + "area": 0, ~/~/ Площадь, м2 5275 + "perimetr": 0, ~/~/ Периметр, м 5276 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5277 +} 5278 +))) 5279 +))) 5280 +))) 5281 +))) 5282 +))) 5283 + 5284 + 5285 +== **Редактирование года урожая ** == 5286 + 5287 +(% class="box successmessage" %) 5288 +((( 5289 +**POST /api/v3/agroLands/updateOpenCloseYear** 5290 +))) 5291 + 5292 +Пример запроса: 5293 + 5294 +((( 5295 +((( 5296 +{ 5297 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5298 + 0 5299 + ], 5300 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5301 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5302 +} 5303 +))) 5304 + 5305 + 5306 +))) 5307 + 5308 +Пример ответа: 5309 + 5310 +((( 5311 +((( 5312 +{ 5313 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5314 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5315 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5316 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5317 + "cropRotations": [ ~/~/ Данные по севообороту 5318 + { 5319 + "landId": 0, ~/~/ ID поля 5320 + "landName": "string", ~/~/ Название поля 5321 + "year": 0, ~/~/ Год урожая 5322 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5323 + "cultureName": "string", ~/~/ Название культуры 5324 + "productivity": 0, ~/~/ Урожайность 5325 + "area": 0, ~/~/ Площадь поля, Га. 5326 + "total": 0, ~/~/ Валовый сбор 5327 + "productivityFact": 0, ~/~/ Фактическая урожайность 5328 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5329 + "totalFact": 0, ~/~/ Фактический валовый сбор 5330 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5331 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5332 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5333 + "isyearplan": true, ~/~/ 5334 + "comment": "string" ~/~/ Комментарий 5335 + } 5336 + ], 5337 + "cropVegetation": [ ~/~/ История вегетации поля 5338 + { 5339 + "values": [ ~/~/ Данные вегетации и состояния посева 5340 + { 5341 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5342 + "ndvi": 0 ~/~/ Индекс вегетации 5343 + } 5344 + ], 5345 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5346 + { 5347 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5348 + "type": "string", ~/~/ Тип 5349 + "pictureid": "string" ~/~/ Идентификатор ресурса 5350 + } 5351 + ], 5352 + "states": [ ~/~/ Ключевые даты развития поля 5353 + { 5354 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5355 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5356 + } 5357 + ] 5358 + } 5359 + ], 5360 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5361 + "counts": { 5362 + "fieldOperations": 0, ~/~/ Количество операций на поле 5363 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5364 + "facts": 0 ~/~/ Счётчик факта 5365 + }, 5366 + "planComment": "string", ~/~/ Комментарий к полю 5367 + "productivity": 0, ~/~/ Урожайность. 5368 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5369 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5370 + "year": 0, ~/~/ Год поля 5371 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5372 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5373 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5374 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5375 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5376 + "id": 0, ~/~/ Идентификатор объекта геозоны 5377 + "name": "string", ~/~/ Название объекта геозоны 5378 + "type": 0, ~/~/ Тип объекта геозоны 5379 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5380 + "fname": "string", ~/~/ Имя файла 5381 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5382 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5383 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5384 + "description": "string", ~/~/ Описание объекта геозоны 5385 + "area": 0, ~/~/ Площадь, м2 5386 + "perimetr": 0, ~/~/ ериметр, м 5387 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5388 +} 5389 +))) 5390 + 5391 + 5392 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5393 +))) 5394 +))) 5395 +))) 5396 + 5397 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5398 + 5399 + 5400 +(% class="box infomessage" %) 5401 +((( 5402 +**GET api/v3/Vehicles/recyclebin/all** 5403 +))) 5404 + 5405 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5406 + 5407 +Параметр запроса: {parentId} - идентификатор агента 5408 + 5409 +В заголовках запроса: X-Auth: Токен авторизации 5410 + 5411 +Ответ: 5412 + 5413 +[ 5414 + { 5415 + "recordTime": "", ~/~/Время записи 5416 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5417 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5418 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5419 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5420 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5421 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5422 + "items": [ ~/~/ 5423 +nullable: true ~/~/Детали 5424 + { 5425 + "name": "string", ~/~/наименование столбца 5426 + "value": "string" ~/~/содержание столбца 5427 + } 5428 + ] 5429 + }, 5430 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5431 + "string" 5432 + ] 5433 + } 5434 +] 5435 + 5436 + 5437 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5438 + 5439 +(% class="box infomessage" %) 5440 +((( 5441 +**POST api/v3/Vehicles/recyclebin/erase** 5442 +))) 5443 + 5444 +В заголовках запроса: X-Auth: Токен авторизации 5445 + 5446 +Пример запроса: 5447 + 5448 +[ 5449 +0 5450 +] 5451 + 5452 + 5453 +Пример ответа: 5454 + 5455 +[ 5456 +{ 5457 + "recordTime": "", ~/~/Время записи 5458 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5459 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5460 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5461 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5462 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5463 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5464 + "items": [ ~/~/Детали 5465 + { 5466 + "name": "", ~/~/Имя свойства 5467 + "value": "" ~/~/Значение свойства 5468 + } 5469 + ] 5470 + }, 5471 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5472 + "" 5473 + ] 5474 + } 5475 +] 5476 + 5477 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5478 + 5479 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5480 + 5481 +(% class="box infomessage" %) 5482 +((( 5483 +**POST api/v3/Vehicles/recyclebin/restore** 5484 +))) 5485 + 5486 +В заголовках запроса: X-Auth: Токен авторизации 5487 + 5488 +Параметры в теле запроса (JSON): 5489 + 5490 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5491 + 5492 +В заголовках запроса: X-Auth: Токен авторизации 5493 + 5494 + 5495 +Пример запроса: 5496 + 5497 +((( 5498 +[ 5499 +))) 5500 + 5501 +((( 5502 + 0 5503 +))) 5504 + 5505 +((( 5506 +] 5507 +))) 5508 + 5509 + 5510 +Пример ответа: 5511 + 5512 +[ 5513 +{ 5514 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5515 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5516 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5517 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5518 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5519 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5520 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5521 + "items": [ ~/~/Детали 5522 + { 5523 + "name": "string", ~/~/Имя свойства 5524 + "value": "string" ~/~/Значение свойства 5525 + } 5526 + ] 5527 + }, 5528 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5529 + "string" 5530 + ] 5531 + } 5532 +] 5533 + 5534 + 5535 += **Раздел: Журнал заданий ** = 5536 + 5537 + 5538 +== **Создание задания в Журнале заданий** == 5539 + 5540 +(% class="box infomessage" %) 5541 +((( 5542 +**POST /api/v3/vehicletasks** 5543 +))) 5544 + 5545 +Пример запроса: 5546 + 5547 +((( 5548 +{ 5549 + "vehicleId": 0, ~/~/ Идентификатор ТС 5550 + "description": "string", ~/~/ Описание 5551 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5552 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5553 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5554 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5555 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5556 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5557 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5558 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5559 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5560 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5561 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5562 + "cost": { 5563 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5564 + "Name": "string", ~/~/ Наименование 5565 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5566 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5567 + "Norm": 0 ~/~/ Норма внесения 5568 + }, 5569 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5570 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5571 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5572 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5573 + "deleted": true, ~/~/ Признак удаления 5574 + "extId": "string", 5575 + "GeoIds": [ ~/~/ Cвязанные поля 5576 + 0 5577 + ] 5578 +} 5579 +))) 5580 + 5581 + 5582 +Пример ответа: 5583 + 5584 +{ 5585 + "vehicleId": 0, ~/~/ Идентификатор ТС 5586 + "description": "string", ~/~/ Описание 5587 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5588 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5589 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5590 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5591 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5592 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5593 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5594 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5595 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5596 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5597 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5598 + "cost": { 5599 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5600 + "Name": "string", ~/~/ Наименование 5601 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5602 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5603 + "Norm": 0 ~/~/ Норма внесения 5604 + }, 5605 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5606 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5607 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5608 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5609 + "deleted": true, ~/~/ Признак удаления 5610 + "extId": "string", ~/~/ ExtId 5611 + "GeoIds": [ ~/~/ Связанные поля 5612 + 0 5613 + ] 5614 +} 5615 + 5616 + 5617 +== **Редактирование задания в Журнале заданий** == 5618 + 5619 +(% class="box successmessage" %) 5620 +((( 5621 +**PUT /api/v3/vehicletasks** 5622 +))) 5623 + 5624 +Пример запроса: 5625 + 5626 +((( 5627 +{ 5628 + "vehicleId": 0, ~/~/ Идентификатор ТС 5629 + "description": "string", ~/~/ Описание 5630 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5631 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5632 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5633 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5634 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5635 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5636 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5637 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5638 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5639 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5640 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5641 + "cost": { 5642 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5643 + "Name": "string", ~/~/ Наименование 5644 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5645 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5646 + "Norm": 0 ~/~/ Норма внесения 5647 + }, 5648 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5649 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5650 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5651 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5652 + "deleted": true, ~/~/ Признак удаления 5653 + "extId": "string", ~/~/ ExtId 5654 + "GeoIds": [ ~/~/ Связанные поля 5655 + 0 5656 + ] 5657 +} 5658 +))) 5659 + 5660 + 5661 +Пример ответа: 5662 + 5663 +{ 5664 + "vehicleId": 0, ~/~/ Идентификатор ТС 5665 + "description": "string", ~/~/ Описание 5666 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5667 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5668 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5669 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5670 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5671 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5672 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5673 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5674 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5675 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5676 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5677 + "cost": { 5678 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5679 + "Name": "string", ~/~/ Наименование 5680 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5681 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5682 + "Norm": 0 ~/~/ Норма внесения 5683 + }, 5684 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5685 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5686 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5687 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5688 + "deleted": true, ~/~/ Признак удаления 5689 + "extId": "string", ~/~/ ExtId 5690 + "GeoIds": [ ~/~/ Связанные поля 5691 + 0 5692 + ] 5693 +} 5694 + 5695 + 5696 +== **Удаление задания в Журнале заданий** == 5697 + 5698 +(% class="box warningmessage" %) 5699 +((( 5700 +**DELETE /api/v3/vehicletasks** 5701 +))) 5702 + 5703 +Пример запроса: 5704 + 5705 +((( 5706 +[ 5707 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5708 +] 5709 +))) 5710 + 5711 +((( 5712 + 5713 +))) 5714 + 5715 +Пример ответа: 5716 + 5717 +{ 5718 + "vehicleId": 0, ~/~/ Идентификатор ТС 5719 + "description": "string", ~/~/ Описание 5720 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5721 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5722 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5723 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5724 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5725 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5726 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5727 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5728 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5729 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5730 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5731 + "cost": { 5732 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5733 + "Name": "string", ~/~/ Наименование 5734 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5735 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5736 + "Norm": 0 ~/~/ Норма внесения 5737 + }, 5738 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5739 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5740 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5741 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5742 + "deleted": true, ~/~/ Признак удаления 5743 + "extId": "string", ~/~/ ExtId 5744 + "GeoIds": [ ~/~/ Связанные поля 5745 + 0 5746 + ] 5747 +} 5748 + 5749 + 5750 +== **Получение списка Журнала заданий** == 5751 + 5752 +(% class="box infomessage" %) 5753 +((( 5754 +**POST /api/v3/vehicletasks/getbyperiod** 5755 +))) 5756 + 5757 +Пример запроса: 5758 + 5759 +((( 5760 +{ 5761 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5762 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5763 + "TimeZone": 0, ~/~/ Часовой пояс. 5764 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5765 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5766 + ], 5767 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5768 + 0 5769 + ], 5770 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5771 + 0 5772 + ], 5773 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5774 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5775 +} 5776 +))) 5777 + 5778 + 5779 +Пример ответа: 5780 + 5781 +((( 5782 +{ 5783 + "total": 0, ~/~/ Общее количество записей 5784 + "pages": 0, ~/~/ Общее количество страниц 5785 + "currentPage": 0, ~/~/ Текущая страница 5786 + "items": [ ~/~/ Записи 5787 + { 5788 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5789 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5790 + "name": "string", ~/~/ Название задания. 5791 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5792 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5793 + "workKind": "string", ~/~/ Вид работ 5794 + "techOp": "string", ~/~/ Тех. операция 5795 + "trailerModel": "string", ~/~/ Модель агрегата 5796 + "width": "string", ~/~/ Ширина, м 5797 + "speed": "string", ~/~/ Тех. скорость 5798 + "fields": "string", ~/~/ Поля 5799 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5800 + "vehicles": "string", ~/~/ Объект-модель 5801 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5802 + "drivers": "string", ~/~/ Водители 5803 + "tmc": "string", ~/~/ ТМЦ 5804 + "client": "string", ~/~/ Клиент 5805 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5806 + "dep": "string", ~/~/ Подразделение 5807 + "geoIds": [ ~/~/ Связанные поля 5808 + 0 5809 + ] 5810 + } 5811 + ] 5812 +} 5813 +))) 5814 + 5815 + 5816 += **Раздел: Локатор ** = 5817 + 5818 + 5819 +== **Получение списка локаторов, доступных пользователю ** == 5820 + 5821 +(% class="box infomessage" %) 5822 +((( 5823 +**GET /api/v3/locators** 5824 +))) 5825 + 5826 +В заголовках запроса: X-Auth: Токен авторизации 5827 + 5828 + 5829 +Пример ответа: 5830 + 5831 +((( 5832 +[ 5833 + { 5834 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5835 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5836 + "agentName": "string", ~/~/ Наименование агента. 5837 + "isEnabled": true, ~/~/ Активен 5838 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5839 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5840 + "name": "string", ~/~/ Наименование 5841 + "status": 0, ~/~/ 5842 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5843 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5844 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5845 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5846 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5847 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5848 + "url": "string", ~/~/ Ссылка 5849 + "language": 0, ~/~/ Язык. 5850 + "vehiclesCount": 0, ~/~/ Количество объектов. 5851 + "geozonesCount": 0, ~/~/ Количество геозон. 5852 + "fieldsCount": 0 ~/~/ Количество полей. 5853 + } 5854 +] 5855 +))) 5856 + 5857 + 5858 + 5859 +== **Создание локатора** == 5860 + 5861 +(% class="box successmessage" %) 5862 +((( 5863 +**POST /api/v3/locators** 5864 +))) 5865 + 5866 +Пример запроса: 5867 + 5868 +((( 5869 +{ 5870 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5871 + "isEnabled": true, ~/~/ Активность 5872 + "name": "string", ~/~/ Наименование локатора 5873 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5874 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5875 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5876 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5877 + "url": "string", ~/~/ Ссылка 5878 + "language": 0 ~/~/ Язык 5879 +} 5880 +))) 5881 + 5882 + 5883 +Пример ответа: 5884 + 5885 +((( 5886 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5887 +))) 5888 + 5889 + 5890 + 5891 +== **Изменение локатора** == 5892 + 5893 +(% class="box infomessage" %) 5894 +((( 5895 +**PUT /api/v3/locators** 5896 +))) 5897 + 5898 +Пример запроса: 5899 + 5900 +((( 5901 +{ 5902 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5903 + "isEnabled": true, ~/~/ Активность 5904 + "name": "string", ~/~/ Наименование 5905 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 5906 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 5907 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5908 + "autoProlongation": true, ~/~/ Автопродление срока действия 5909 + "url": "string", ~/~/ Ссылка 5910 + "language": 0 ~/~/ Язык 5911 +} 5912 +))) 5913 + 5914 + 5915 +Пример ответа: 5916 + 5917 +200 ~/~/ Success 5918 + 5919 + 5920 +== **Удалить локатор** == 5921 + 5922 +(% class="box warningmessage" %) 5923 +((( 5924 +**DELETE /api/v3/locators** 5925 +))) 5926 + 5927 +Пример запроса: 5928 + 5929 +((( 5930 +[ 5931 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 5932 +] 5933 +))) 5934 + 5935 + 5936 + 5937 + 3370 3370 (% class="box" lang="en-US" style="text-align: center;" %) 3371 3371 ((( 3372 3372 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content