Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/01/28 12:59
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,17 @@ 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 + 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" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!29 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 31 + 32 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 33 + 34 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 35 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 38 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 39 +((( 40 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 41 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 42 +))) 22 22 23 -(% class="box infomessage" %)44 +(% 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**__».55 +(% 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" %) 68 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 69 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 74 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 75 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 76 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 77 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 78 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 79 + 80 +(% class="wikigeneratedid" %) 81 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[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}]]) 82 + 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" ~/~/ Корр. счет122 + "agentId": "", (%%) 123 + "parentId": "", 124 + "parentName": "string", 125 + "name": "string", 126 + "fullName": "string", 127 + "agentInfoType": 0, 128 + "isForeign": true/false, 129 + "district": "string", 130 + "region": "string", 131 + "city": "string", 132 + "inn": "string", 133 + "kpp": "string", 134 + "address": "string", 135 + "addressFact": "string", 136 + "email": "string", 137 + "director": "string", 138 + "bankName": "string", 139 + "bankBIK": "string", 140 + "bankRS": "string", 141 + "bankKS": "string" 118 118 } 119 119 144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 145 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 146 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 147 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 148 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 149 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 150 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 151 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 152 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 153 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 154 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 155 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 156 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 157 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 158 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 159 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 160 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 161 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 162 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 163 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 164 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 165 + 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" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».179 +(% 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 - Отказ) 194 + "agentId": "",(% style="color:#000000" %) (%%) 195 + "parentId": "", 196 + "name": "string", 197 + "fullName": "string", 198 + "agentInfoType": 0, 199 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 202 + 203 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 204 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 205 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 206 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 207 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 208 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 209 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 210 + 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 - 229 + "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 273 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 274 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 275 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 276 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 277 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 278 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 279 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 280 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 281 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 282 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 283 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 284 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 285 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 286 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 287 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 288 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 289 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 290 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 291 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 292 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 293 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 294 + 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 376 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 377 + 378 +(% class="box warningmessage" %) 379 +((( 380 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 381 +))) 382 + 383 +Метод позволяет изменить статус клиента, указанного в запросе. 384 + 385 +В пути указывается GUID клиента и статус клиента. 386 + 387 +**status **- значение 0 - заблокирован, 1 - активен. 388 + 389 +Ответ: Code 204 390 + 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 пользователя 455 +{ 456 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 473 +} 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 - 495 +(% 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 пользователя 591 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 592 + "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" %) 614 + "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": "" , ~/~/ идентификатор пользователя 621 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 622 + "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» названия группы пользователя 643 +} 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 - 664 +(% 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 - 689 + "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, ... ... @@ -720,7 +720,7 @@ 720 720 "deleted": true 721 721 } 722 722 723 -|(% style="width:215px" %)Параметр|(% style="width:861px" %)Описание 789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 724 724 |(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 725 725 |(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 726 726 |(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта ... ... @@ -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" %)Скорость выгрузки из бункера, л/сек 798 +|(% 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 клиента, которому принадлежит модель объекта ... ... @@ -751,10 +751,9 @@ 751 751 752 752 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 753 753 754 -(% style="color:#000000" %)Параметры в теле запроса (JSON): 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 755 755 756 -(% style="color:#000000" %){ 757 - "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 758 758 } 759 759 760 760 (% style="color:#000000" %)Ответ: ... ... @@ -769,6 +769,13 @@ 769 769 } 770 770 ] 771 771 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 772 772 == (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 773 773 774 774 (% class="box successmessage" %) ... ... @@ -816,12 +816,25 @@ 816 816 "maxspeed": 0, 817 817 "width": 0, 818 818 "imbeddedtrailer": true, 819 - "fueloutlay": 0, 820 820 "hoppercapacity": 0, 821 821 "hopperdischargespeed": 0, 822 822 "modelType": 0 823 823 } 824 824 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 825 825 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 826 826 827 827 (% class="box warningmessage" %) ... ... @@ -875,6 +875,20 @@ 875 875 "modelType": 0 876 876 } 877 877 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 878 878 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 879 879 880 880 (% class="box errormessage" %) ... ... @@ -894,7 +894,7 @@ 894 894 895 895 Ответ: В случае успеха **Success 200** 896 896 897 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 898 898 899 899 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 900 900 ... ... @@ -923,6 +923,17 @@ 923 923 924 924 ((( 925 925 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 926 926 "vehicleId": "", ~/~/ ID объекта 927 927 "name": "", ~/~/ Имя объекта 928 928 "imei": "", ~/~/ IMEI объекта ... ... @@ -930,19 +930,15 @@ 930 930 "deviceTypeName": "", ~/~/ Название типа устройства 931 931 "sim1": "", ~/~/ Номер SIM1 932 932 "sim2": "", ~/~/ Номер SIM2 933 - 934 934 "parentId": "", ~/~/ ID клиента-родителя 935 935 "parentName": "", ~/~/ Наименование клиента-родителя 936 936 "modelId": "", ~/~/ ID модели объекта 937 937 "modelName": "", ~/~/ Имя модели объекта 938 - 939 939 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 940 940 "unitName": "string", ~/~/ Наименование подразделения 941 941 "status": 0, ~/~/ Статус объекта 942 - 943 943 "createdAt": "", ~/~/ Дата создания объекта 944 944 }, 945 - 946 946 "customFields": [ ~/~/ Произвольные поля 947 947 { 948 948 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -965,8 +965,7 @@ 965 965 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 966 966 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 967 967 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 968 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 969 - 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 970 970 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 971 971 "mileageCoeff": 0, ~/~/ коэффициент пробега 972 972 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -996,7 +996,6 @@ 996 996 "retries": 0 ~/~/ Количество попыток 997 997 } 998 998 ], 999 - 1000 1000 "sensors": [ ~/~/ Датчики 1001 1001 { 1002 1002 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1023,6 +1023,7 @@ 1023 1023 ], 1024 1024 "showInTooltip": true, ~/~/ Отображать в подсказке 1025 1025 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 1026 1026 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1027 1027 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1028 1028 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1037,31 +1037,19 @@ 1037 1037 }, 1038 1038 1039 1039 ~/~/ Характерные для произвольного: 1040 - 1041 1041 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1042 - 1043 1043 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1044 - 1045 1045 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1046 - 1047 1047 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1048 - 1049 1049 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1050 - 1051 1051 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1052 - 1053 1053 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1054 - 1055 1055 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1056 - 1057 1057 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1058 - 1059 1059 ~/~/ "ValueOn": "Вкл.", 1060 - 1061 1061 ~/~/ "ValueOff": "Выкл." 1062 1062 "summaryMaxValue": 0 ~/~/ Макс. значение 1063 1063 } 1064 - 1065 1065 "drivers": [ ~/~/ Водители 1066 1066 { 1067 1067 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1070,7 +1070,6 @@ 1070 1070 "isDefault": true ~/~/ По умолчанию 1071 1071 } 1072 1072 ], 1073 - 1074 1074 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1075 1075 { 1076 1076 "id": "", ~/~/ ID задания ... ... @@ -1087,19 +1087,27 @@ 1087 1087 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1088 1088 } 1089 1089 ], 1090 - 1091 - "statusHistory": [ ~/~/ История статусов 1181 +"statusHistory": [ ~/~/ История статусов 1092 1092 { 1093 1093 "status": 0, 1094 1094 "date": "2023-05-22T09:57:39.562Z", 1095 1095 "description": "string", 1096 1096 "additionalInfo": "string" 1097 - } 1098 - ] 1099 1099 1188 +((( 1100 1100 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1101 1101 ))) 1102 1102 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 1103 1103 (% style="text-align:left" %) 1104 1104 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1105 1105 ... ... @@ -1106,6 +1106,75 @@ 1106 1106 (% style="text-align:left" %) 1107 1107 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1108 1108 1208 + 1209 +== **Отправить команду на терминал** == 1210 + 1211 +(% class="box successmessage" %) 1212 +((( 1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1214 +))) 1215 + 1216 +Команда для отправки на тс. 1217 + 1218 +{ 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1223 +} 1224 + 1225 +В ответ получаем cmdid 1226 + 1227 + 1228 +== **Получить ответ на отправленную на ТС команду** == 1229 + 1230 +(% class="box infomessage" %) 1231 +((( 1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1233 +))) 1234 + 1235 +Идентификатор команды: cmdId 1236 + 1237 +Запрос от терминала на ответ команды 1238 + 1239 +Пример ответ от терминала: 1240 + 1241 +ID= "" ~/~/ идентификатор объекта 1242 +Soft="" ~/~/ версия софта 1243 +GPS=4 ~/~/ тип трекера 1244 +Time=11:05:43 28.06.24 ~/~/ время запроса 1245 +Lat=45.056221 ~/~/ широта 1246 +Lon=39.035938 ~/~/ долгота 1247 +Speed=0.0 ~/~/ скорость 1248 +Course=181.4 ~/~/направление 1249 + 1250 +((( 1251 +== **Список отправленных объекту команд с ответами** == 1252 + 1253 +(% class="box infomessage" %) 1254 +((( 1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1256 +))) 1257 + 1258 +Идентификатор ТС: vehicleId 1259 + 1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1261 + 1262 +Пример ответа терминала 1263 + 1264 +[ 1265 +{ 1266 +"id": "", ~/~/ идентификатор пользователя 1267 +"commandText": "", ~/~/Текст команды. 1268 +"templateId": "", ~/~/Идентификатор шаблона 1269 +"updated": "", ~/~/ Время отправки 1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1271 +"answer": "", ~/~/ Ответ терминала. 1272 +"status": "" ~/~/ Статус отправки 1273 +} 1274 +] 1275 +))) 1276 + 1109 1109 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1110 1110 1111 1111 (% class="box successmessage" %) ... ... @@ -1125,6 +1125,11 @@ 1125 1125 1126 1126 (% style="color:#000000" %){ 1127 1127 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 1128 1128 "parentId": "" , ~/~/ ID клиента 1129 1129 "name": "" , ~/~/ имя ТС 1130 1130 "imei": "" , ~/~/ IMEI ... ... @@ -1145,7 +1145,6 @@ 1145 1145 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1146 1146 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1147 1147 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1148 - 1149 1149 "mileageCalcMethod": 0, 1150 1150 "mileageCoeff": 0, 1151 1151 "locationByCellId": true, ... ... @@ -1178,7 +1178,6 @@ 1178 1178 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1179 1179 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1180 1180 } 1181 - 1182 1182 "drivers": [ ~/~/ Водители 1183 1183 { 1184 1184 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1193,8 +1193,7 @@ 1193 1193 "retries": 0 1194 1194 } 1195 1195 ], 1196 - 1197 - "sensors": [ ~/~/ Датчики 1367 +"sensors": [ ~/~/ Датчики 1198 1198 { 1199 1199 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1200 1200 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1220,6 +1220,7 @@ 1220 1220 ], 1221 1221 "showInTooltip": true, ~/~/ Отображать в подсказке 1222 1222 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1223 1223 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1224 1224 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1225 1225 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1232,103 +1232,293 @@ 1232 1232 "additionalProp2": "string", 1233 1233 "additionalProp3": "string" 1234 1234 }, 1235 - 1236 1236 ~/~/ Характерные для произвольного: 1237 - 1238 1238 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1239 - 1240 1240 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1241 - 1242 1242 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1243 - 1244 1244 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1245 - 1246 1246 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1247 - 1248 1248 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1249 - 1250 1250 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1251 - 1252 1252 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1253 - 1254 1254 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1255 - 1256 1256 ~/~/ "ValueOn": "Вкл.", 1257 - 1258 1258 ~/~/ "ValueOff": "Выкл." 1259 - "summaryMaxValue": 0 ~/~/ Макс. значение 1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1419 + 1420 +((( 1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1422 + { 1423 + "from": 0, ~/~/ С какого значения 1424 + "color": "string", ~/~/ Каким цветом 1425 + "text": "string" ~/~/ Текст подписи к этому интервалу 1426 + } 1427 + ] 1260 1260 } 1261 1261 ], 1430 +))) 1431 + 1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1433 + 1434 + 1262 1262 "customFields": [ ~/~/ Произвольные поля 1263 1263 { 1264 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1265 - "name": "string", 1266 - "value": "string", 1267 - "forClient": true, 1268 - "forTooltip": true, 1269 - "forReport": true 1270 - } 1271 - ] 1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1438 + "name": "string", ~/~/ Наименование произвольного поля 1439 + "value": "string", ~/~/ Значение произвольного поля 1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1272 1272 } 1453 +))) 1273 1273 1455 + 1274 1274 (% style="color:#000000" %)Ответ: 1275 1275 1276 -(% style="color:#000000" %){ 1277 1277 1278 - "vehicleId": "", ~/~/ID ТС 1279 - "parentId": "", ~/~/Guid владельца ТС 1280 - "name": "", ~/~/Имя объекта 1281 - "imei": "", ~/~/IMEI 1282 - "deviceTypeId": "", ~/~/ID типа устройства 1283 - "modelId": "", ~/~/ID модели 1284 - "unitId": "", ~/~/ID подразделения 1285 - "sim1": "", ~/~/SIM1 1286 - "sim2": "", ~/~/SIM2 1287 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1288 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1289 - "counters": { ~/~/Счётчики 1290 - "mileageEnabled": true, 1291 - "motohoursEnabled": true, 1292 - "mileage": "", 1293 - "motohours": 345.0 1294 - }, 1295 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1296 - "id": null, 1297 - "enabled": true, ~/~/флаг включения 1298 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1299 - "login": "", ~/~/ имя учетной записи 1300 - "password": "" ~/~/ пароль учетной записи 1301 - }, 1302 - "inspectionTasks": { ~/~/ задания на ТО 1303 - "id": "", ~/~/ ID задачи 1304 - "enabled": false, ~/~/ Признак включения 1305 - "name": "", ~/~/ Имя задания 1306 - "description": "", ~/~/ Описание задания 1307 - "mileageCondition": "", ~/~/ Условие по пробегу 1308 - "lastMileage": "", ~/~/ Пробег (в метрах) 1309 - "motohoursCondition": "", ~/~/ Условие по моточасам 1310 - "lastMotohours": "", ~/~/ Моточасы 1311 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1312 - "kind": "", ~/~/ Вид периодичности по времени 1313 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1459 +((( 1460 +((( 1461 +((( 1462 +{ 1463 + "vehicleId": 0, ~/~/ ID ТС 1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1465 + "name": "string", ~/~/ Имя объекта 1466 + "imei": "string", ~/~/ IMEI 1467 + "deviceTypeId": 0, ~/~/ ID типа устройства 1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1470 + "sim1": "string", ~/~/ SIM1 1471 + "sim2": "string", ~/~/ SIM2 1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1474 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1489 + "counters": { ~/~/ Dto для состояний счётчиков 1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1492 + "mileage": 0, ~/~/ Пробег 1493 + "motohours": 0 ~/~/ Моточасы 1494 + }, 1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1496 + "id": "string", ~/~/ CMSV6 Идентификатор 1497 + "enabled": true, ~/~/ Признак включения 1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1499 + "login": "string", ~/~/ CMSV6 имя учетной записи 1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1501 + }, 1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1503 + { 1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1505 + "enabled": true, ~/~/ Признак включения 1506 + "name": "string", ~/~/ Имя задания 1507 + "description": "string", ~/~/ Описание задания 1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1314 1314 } 1517 + ], 1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1519 + { 1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1521 + "inputNumber": 0, ~/~/ № входа. 1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1523 + "comment": "string", ~/~/ Комментарий 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1528 + } 1529 + ], 1530 + "commandTemplates": [ ~/~/ Список шаблонов команд 1531 + { 1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1533 + "name": "string", ~/~/ Название шаблона команд 1534 + "command": "string", ~/~/ Команда на выполнение 1535 + "retries": 0 ~/~/ Лимит попыток отправки 1536 + } 1537 + ], 1538 + "sensors": [ ~/~/ Список датчиков 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1542 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1543 + "name": "string", ~/~/ Имя датчика 1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1545 + "inputNumber": 0, ~/~/ Номер входа 1546 + "pseudonym": "string", ~/~/ Псевдоним 1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1548 + "isInverted": true, ~/~/ Признак инверсии 1549 + "disabled": true, ~/~/ Датчик не участвует в обработке 1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1551 + "gradesTables": [ ~/~/ Тарировка 1552 + { 1553 + "grades": [ ~/~/ Таблицы тарировки 1554 + { 1555 + "input": 0, ~/~/ Вход 1556 + "output": 0 ~/~/ Выход 1557 + } 1558 + ], 1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1560 + } 1561 + ], 1562 + "showInTooltip": true, ~/~/ Отображение в подсказке 1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1567 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1568 + "expr": "string", ~/~/ Выражение 1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1570 + "string" 1571 + ], 1572 + "customParams": { 1573 + "additionalProp1": "string", 1574 + "additionalProp2": "string", 1575 + "additionalProp3": "string" 1576 + }, 1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1578 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1579 + { 1580 + "from": 0, ~/~/ С какого значения 1581 + "color": "string", ~/~/ Каким цветом 1582 +))) 1315 1315 1316 -(% style="text-align:left" %) 1317 -(% style="color:#000000" %)} 1584 +((( 1585 + "text": "string" ~/~/ Текст подписи к этому интервалу 1586 + } 1587 + ] 1588 + } 1589 + ], 1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1591 + "customFields": [ ~/~/ Список произвольных полей 1592 + { 1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1594 + "name": "string", ~/~/ Наименование произвольного поля 1595 + "value": "string", ~/~/ Значение произвольного поля 1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1599 + } 1600 + ], 1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1602 +} 1603 +))) 1604 +))) 1605 +))) 1318 1318 1607 + 1319 1319 **Валидация:** 1320 1320 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1321 1321 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1322 1322 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1323 1323 1324 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1325 1325 1614 +== **Импортировать историю ТС (Асинхронный запрос)** == 1615 + 1616 +(% class="box successmessage" %) 1617 +((( 1618 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1619 +))) 1620 + 1621 +Метод запроса: **POST** 1622 + 1623 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1624 + 1625 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1626 + 1627 + 1628 +Ответ: 1629 + 1630 +{ 1631 + 1632 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1633 + 1634 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1635 + 1636 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1637 + 1638 + "Message": "string", ~/~/ Информация о выполнении запроса 1639 + 1640 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1641 + 1642 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1643 + 1644 + "Data": "string" ~/~/ Данные 1645 + 1646 +} 1647 + 1648 + 1649 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1650 + 1326 1326 (% class="box infomessage" %) 1327 1327 ((( 1653 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1654 +))) 1655 + 1656 +Метод запроса: **GET** 1657 + 1658 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1659 + 1660 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1661 + 1662 + 1663 +Ответ: 1664 + 1665 +{ 1666 + 1667 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1668 + 1669 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1670 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1671 + 1672 + "Message": "string", ~/~/ Информация о выполнении запроса 1673 + 1674 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1675 + 1676 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1677 + 1678 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1679 + 1680 + "Data": "string" ~/~/ Данные 1681 + 1682 +} 1683 + 1684 + 1685 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1686 + 1687 +(% class="box infomessage" %) 1688 +((( 1328 1328 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1329 1329 ))) 1330 1330 1331 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1692 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1332 1332 1333 1333 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1334 1334 ... ... @@ -1362,9 +1362,12 @@ 1362 1362 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1363 1363 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1364 1364 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1365 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1366 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1367 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1726 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1727 + "unitName": "string", ~/~/ Название подразделения (опционально) 1728 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1729 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1730 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1731 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1368 1368 } 1369 1369 1370 1370 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1371,8 +1371,14 @@ 1371 1371 1372 1372 (% style="color:#000000" %)Ответ: 1373 1373 1374 -(% style="color:#000000" %){ 1738 +(% style="color:#000000" %)[ 1739 +{ 1375 1375 1741 +((( 1742 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1743 +))) 1744 + 1745 +((( 1376 1376 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1377 1377 "name": "" ~/~/ наименование объекта 1378 1378 "imei": "" ~/~/ IMEI объекта ... ... @@ -1398,9 +1398,21 @@ 1398 1398 "forClient": true, ~/~/ право на отображение у клиента 1399 1399 "forTooltip": false, ~/~/ право на отображение в подсказке 1400 1400 "forReport": false ~/~/ право на отображение в отчетах 1401 - }(%%) 1402 -(% style="color:#000000" %)} 1771 +))) 1403 1403 1773 +((( 1774 + } 1775 + ], 1776 + "vehicleGroups": [ ~/~/ Группы ТС 1777 + { 1778 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1779 + "name": "string" ~/~/ Наименование группы ТС 1780 + } 1781 + ] 1782 + } 1783 +] 1784 +))) 1785 + 1404 1404 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1405 1405 1406 1406 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1432,13 +1432,11 @@ 1432 1432 "data": "", ~/~/ Данные 1433 1433 "overwrite": false, ~/~/ Флаг перезаписи 1434 1434 "stage": "", ~/~/ Состояние, может быть null 1435 - 1436 1436 (% style="color:#000000" %)} 1437 1437 1438 1438 (% style="color:#000000" %)Ответ: 1439 1439 1440 -(% style="color:#000000" %){ 1441 - 1821 +(% style="color:#000000" %){(%%) 1442 1442 "status": "", ~/~/ значение статуса 1443 1443 "date": "", ~/~/ Дата смены статуса 1444 1444 "description": "", ~/~/ Описание ... ... @@ -1445,10 +1445,10 @@ 1445 1445 "data": "", ~/~/ Данные 1446 1446 "overwrite": false, ~/~/ Флаг перезаписи 1447 1447 "stage": "", ~/~/ Состояние 1448 - 1449 -(% style="text-align:left" %) 1450 1450 (% style="color:#000000" %) } 1451 1451 1830 +== == 1831 + 1452 1452 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1453 1453 1454 1454 (% class="box warningmessage" %) ... ... @@ -1524,9 +1524,19 @@ 1524 1524 1525 1525 "drivers": [ ~/~/ Водители 1526 1526 { 1527 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1528 - "isDefault": true 1529 - } 1907 + 1908 +((( 1909 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1910 + "inputNumber": 0, ~/~/ № входа. 1911 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1912 + "comment": "string", ~/~/ Комментарий. 1913 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1914 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1915 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1916 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1917 +))) 1918 + 1919 + } 1530 1530 ], 1531 1531 "commandTemplates": [ ~/~/ Шаблон команды 1532 1532 { ... ... @@ -1536,8 +1536,7 @@ 1536 1536 "retries": 0 1537 1537 } 1538 1538 ], 1539 - 1540 - "sensors": [ ~/~/ Датчики 1929 +"sensors": [ ~/~/ Датчики 1541 1541 { 1542 1542 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1543 1543 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1563,6 +1563,11 @@ 1563 1563 ], 1564 1564 "showInTooltip": true, ~/~/ Отображать в подсказке 1565 1565 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1955 + 1956 +((( 1957 + "color": "string",** ~/~/ **Цвет датчика 1958 +))) 1959 + 1566 1566 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1567 1567 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1568 1568 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1575,95 +1575,225 @@ 1575 1575 "additionalProp2": "string", 1576 1576 "additionalProp3": "string" 1577 1577 }, 1578 - 1579 1579 ~/~/ Характерные для произвольного: 1580 - 1581 1581 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1582 - 1583 1583 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1584 - 1585 1585 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1586 - 1587 1587 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1588 - 1589 1589 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1590 - 1591 1591 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1592 - 1593 1593 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1594 - 1595 1595 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1596 - 1597 1597 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1598 - 1599 1599 ~/~/ "ValueOn": "Вкл.", 1600 - 1601 1601 ~/~/ "ValueOff": "Выкл." 1602 1602 "summaryMaxValue": 0 ~/~/ Макс. значение 1985 + 1986 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1987 + { 1988 + "from": 0, ~/~/ С какого значения 1989 + "color": "string", ~/~/ Каким цветом 1990 + "text": "string" ~/~/ Текст подписи к этому интервалу 1991 + } 1992 + ] 1603 1603 } 1604 1604 ], 1995 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1996 + 1605 1605 "customFields": [ ~/~/ Произвольные поля 1606 - { 1607 - 1608 - "name": "string", 1609 - "value": "string", 1610 - "forClient": true, 1611 - "forTooltip": true, 1612 - "forReport": true 1998 + { 1999 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2000 + "name": "string", ~/~/ Наименование произвольного поля 2001 + "value": "string", ~/~/ Значение произвольного поля 2002 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2003 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2004 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1613 1613 } 1614 - ] 2006 + 2007 +((( 2008 + ], 2009 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2010 +))) 2011 + 1615 1615 } 1616 1616 2014 + 1617 1617 (% style="color:#000000" %)Ответ: 1618 1618 1619 -(% lang="en-US" style="text-align:left" %) 1620 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 2017 +((( 2018 +{ 2019 + "vehicleId": 0, ~/~/ ID ТС 2020 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 2021 + "name": "string", ~/~/ Имя объекта 2022 + "imei": "string", ~/~/ IMEI 2023 + "deviceTypeId": 0, ~/~/ ID типа устройства 2024 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 2025 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 2026 + "sim1": "string", ~/~/ SIM1 2027 + "sim2": "string", ~/~/ SIM2 2028 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 2029 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 2030 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 2031 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 2032 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 2033 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 2034 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 2035 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 2036 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 2037 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 2038 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 2039 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 2040 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 2041 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 2042 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 2043 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 2044 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 2045 + "counters": { ~/~/ состояний счётчиков 2046 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 2047 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 2048 + "mileage": 0, ~/~/ Пробег 2049 + "motohours": 0 ~/~/ Моточасы 2050 + }, 2051 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2052 + "id": "string", ~/~/ CMSV6 Идентификатор 2053 + "enabled": true, ~/~/ Признак включения 2054 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2055 +))) 1621 1621 1622 -(% lang="en-US" style="text-align:left" %) 1623 - "vehicleId": "", ~/~/ ID ТС 1624 - "parentId": "", ~/~/ ID клиента 1625 - "name": "", ~/~/ имя ТС 1626 - "imei": "", ~/~/ IMEI 1627 - "deviceTypeId": "", ~/~/ типа устройства 1628 - "modelId": "", ~/~/ ID модели 1629 - "unitId": "", ~/~/ ID подразделения 1630 - "sim1": "", ~/~/ SIM 1 1631 - "sim2": "", ~/~/ SIM2 1632 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1633 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1634 - "counters": 1635 - { 1636 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1637 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1638 - "mileage": "", ~/~/ пробег 1639 - "motohours": "", ~/~/ моточасы 1640 - } 1641 - "cmsv6Parameters": ~/~/ параметры CMSv6 2057 + 2058 +((( 2059 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2060 + "login": "string", ~/~/ CMSV6 имя учетной записи 2061 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2062 + }, 2063 + "inspectionTasks": [ ~/~/ Задания на ТО 2064 + { 2065 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2066 + "enabled": true, ~/~/ Признак включения 2067 + "name": "string", ~/~/ Имя задания 2068 + "description": "string", ~/~/ Описание задания 2069 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2070 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2071 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2072 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2073 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2074 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2075 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2076 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2077 + } 2078 + ], 2079 + "drivers": [ ~/~/ Список водителей 2080 + { 2081 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2082 + "inputNumber": 0, ~/~/ № входа. 2083 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2084 + "comment": "string", ~/~/ Комментарий. 2085 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2086 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2087 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2088 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2089 + } 2090 + ], 2091 + "commandTemplates": [ ~/~/ Список шаблонов команд 2092 + { 2093 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2094 + "name": "string", ~/~/ Название шаблона команд 2095 + "command": "string", ~/~/ Команда на выполнение 2096 + "retries": 0 ~/~/ Лимит попыток отправки 2097 + } 2098 + ], 2099 + "sensors": [ ~/~/ Список датчиков 2100 + { 2101 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2102 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2103 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2104 +))) 2105 + 2106 +((( 2107 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2108 +))) 2109 + 2110 +((( 2111 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2112 +))) 2113 + 2114 +((( 2115 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2116 +))) 2117 + 2118 +((( 2119 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2120 +))) 2121 + 2122 +((( 2123 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2124 + "name": "string", ~/~/ Имя датчика 2125 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2126 +))) 2127 + 2128 +((( 2129 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2130 + "inputNumber": 0, ~/~/ Номер входа 2131 + "pseudonym": "string", ~/~/ Псевдоним 2132 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2133 + "isInverted": true, ~/~/ Признак инверсии 2134 + "disabled": true, ~/~/ Датчик не участвует в обработке 2135 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2136 + "gradesTables": [ ~/~/ Тарировка 1642 1642 { 1643 - "id": ~/~/ идентификатор 1644 - "enabled": true, ~/~/ флаг включения 1645 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1646 - "login": "", ~/~/ имя учетной записи 1647 - "password": "", ~/~/ пароль учетной записи 1648 - } 1649 - "inspectionTasks": ~/~/ задания на ТО 1650 - { 1651 - "id": "", ~/~/ ID задания 1652 - "enabled": false, ~/~/ Признак включения 1653 - "name": "", ~/~/ Имя задания 1654 - "description": "", ~/~/ Описание задания 1655 - "mileageCondition": "", ~/~/ Условие по пробегу 1656 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1657 - "motohoursCondition": "", ~/~/ Условие по моточасам 1658 - "lastMotohours": "", ~/~/ Моточасы 1659 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1660 - "kind": "", ~/~/ Вид периодичности по времени 1661 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2138 + "grades": [ ~/~/ Таблицы тарировки 2139 + { 2140 + "input": 0, ~/~/ Вход 2141 + "output": 0 ~/~/ Выход 2142 + } 2143 + ], 2144 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1662 1662 } 2146 + ], 2147 + "showInTooltip": true, ~/~/ Отображение в подсказке 2148 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1663 1663 1664 -(% lang="en-US" style="text-align:left" %) 1665 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2150 +((( 2151 + "color": "string", ~/~/ цвет уведомлений 2152 +))) 1666 1666 2154 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2155 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2156 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2157 + "expr": "string", ~/~/ Выражение 2158 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2159 + "string" 2160 + ], 2161 + "customParams": { ~/~/ Дополнительные настройки 2162 + "additionalProp1": "string", 2163 + "additionalProp2": "string", 2164 + "additionalProp3": "string" 2165 + }, 2166 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2167 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2168 + { 2169 + "from": 0, ~/~/ С какого значения 2170 + "color": "string", ~/~/ Каким цветом 2171 + "text": "string" ~/~/ Текст подписи к этому интервалу 2172 + } 2173 + ] 2174 + } 2175 + ], 2176 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2177 + "customFields": [ ~/~/ Список произвольных полей 2178 + { 2179 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2180 + "name": "string", ~/~/ Наименование произвольного поля 2181 + "value": "string", ~/~/ Значение произвольного поля 2182 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2183 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2184 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2185 + } 2186 + ], 2187 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2188 +} 2189 +))) 2190 + 1667 1667 **Валидация:** 1668 1668 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1669 1669 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1702,18 +1702,15 @@ 1702 1702 1703 1703 (% style="color:#000000" %)Метод запроса: **GET** 1704 1704 1705 -(% 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]]2229 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1706 1706 1707 1707 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1708 1708 1709 1709 (% style="color:#000000" %)Ответ: 1710 1710 1711 -(% style="color:#000000" %){ 1712 - 2235 +(% style="color:#000000" %){(%%) 1713 1713 "deviceTypeId" : "", ~/~/ ID типа устройства 1714 1714 "deviceTypeName" : "" ~/~/ Название типа устройства 1715 - 1716 -(% style="text-align:left" %) 1717 1717 (% style="color:#000000" %)} 1718 1718 1719 1719 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1735,13 +1735,10 @@ 1735 1735 1736 1736 (% style="color:#000000" %)Ответ: 1737 1737 1738 -(% style="color:#000000" %){ 1739 - 2259 +(% style="color:#000000" %){(%%) 1740 1740 "id": "", ~/~/ ID типа датчика 1741 1741 "name": "", ~/~/ Название 1742 1742 "description": "", ~/~/ Описание 1743 - 1744 -(% style="text-align:left" %) 1745 1745 (% style="color:#000000" %)} 1746 1746 1747 1747 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1785,6 +1785,56 @@ 1785 1785 } 1786 1786 ] 1787 1787 2306 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2307 + 2308 +(% class="box infomessage" style="text-align: left;" %) 2309 +((( 2310 +**POST /api/v3/terminalMessages/mapping** 2311 +))) 2312 + 2313 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2314 + 2315 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2316 + 2317 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2318 + 2319 +{ 2320 + "protocolType": 0, 2321 + "params": ["string"] 2322 +} 2323 + 2324 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2325 +|protocolType|ID типа протокола 2326 +|params|((( 2327 +Массив наименований параметров в сообщении 2328 +))) 2329 + 2330 +Ответ: 2331 + 2332 +{ 2333 + "protocolType": 0, 2334 + "mapping": { 2335 + "additionalProp1": { 2336 + "inputType": 0, 2337 + "inputNumber": 0 2338 + }, 2339 + "additionalProp2": { 2340 + "inputType": 0, 2341 + "inputNumber": 0 2342 + } 2343 + } 2344 +} 2345 + 2346 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2347 +|protocolType|Тип протокола 2348 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2349 +|inputNumber|((( 2350 +Номер входа 2351 +))) 2352 + 2353 +(% class="wikigeneratedid" %) 2354 +Перечень 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/]] 2355 + 1788 1788 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1789 1789 1790 1790 (% class="box infomessage" %) ... ... @@ -1809,6 +1809,11 @@ 1809 1809 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1810 1810 } 1811 1811 2380 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2381 +|vehicleId|ID объекта 2382 +|from|Дата и время начала периода запроса 2383 +|to|Дата и время окончания периода запроса 2384 + 1812 1812 Ответ: 1813 1813 1814 1814 [ ... ... @@ -1815,80 +1815,43 @@ 1815 1815 { 1816 1816 "messages": [ 1817 1817 { 1818 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1819 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1820 - "speed": 0, ~/~/ Скорость, км/ч 1821 - "altitude": 0, ~/~/ Высота, м 1822 - "latitude": 0, ~/~/ Широта [-90°;90°] 1823 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1824 - "satellites": 0, ~/~/ Кол-во спутников 1825 - "voltage": 0, ~/~/ Напряжение 1826 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2391 + "deviceTime": "2023-11-29T07:40:44.052Z", 2392 + "serverTime": "2023-11-29T07:40:44.052Z", 2393 + "speed": 0, 2394 + "altitude": 0, 2395 + "latitude": 0, 2396 + "longitude": 0, 2397 + "satellites": 0, 2398 + "course": 0, 2399 + "voltage": 0, 2400 + "parameters": { 1827 1827 "additionalProp1": "string", 1828 1828 "additionalProp2": "string", 1829 1829 "additionalProp3": "string" 1830 1830 }, 1831 - "photoCount": 0 ~/~/ Кол-во фото 2405 + "photoCount": 0, 2406 + "lbsCorrectedCoords": true, 2407 + "protocolType": 0 1832 1832 } 1833 1833 ] 1834 1834 } 1835 1835 ] 1836 1836 1837 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2413 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2414 +|deviceTime|Время сообщения терминала 2415 +|serverTime|Время когда сообщение поступило на сервер 2416 +|speed|Скорость 2417 +|altitude|Высота над уровнем моря 2418 +|latitude|Широта 2419 +|longitude|Долгота 2420 +|satellites|Кол-во спутников 2421 +|course|Курс 2422 +|voltage|Бортовое напряжение 2423 +|parameters|Список параметров и их значений 2424 +|photoCount|Количество фото 2425 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2426 +|protocolType|ID типа протокола 1838 1838 1839 -(% class="box infomessage" %) 1840 -((( 1841 -**POST /api/v3/vehicles/export/history** 1842 -))) 1843 - 1844 -Метод возвращает список сообщений терминала объекта за выбранный период. 1845 - 1846 -(% style="text-align: left;" %) 1847 -Метод запроса **POST** 1848 - 1849 -(% style="text-align: left;" %) 1850 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1851 - 1852 -(% style="text-align: left;" %) 1853 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1854 - 1855 -{ 1856 - "vehicleId": 0, ~/~/ ID объекта 1857 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1858 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1859 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1860 -} 1861 - 1862 -Ответ: 1863 - 1864 -Получаете файл. Сообщение: Code 200/Success 1865 - 1866 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1867 - 1868 -(% class="box infomessage" %) 1869 -((( 1870 -**GET /api/v3/vehicles/export/history/status** 1871 -))) 1872 - 1873 -Метод возвращает список сообщений терминала объекта за выбранный период. 1874 - 1875 -(% style="text-align: left;" %) 1876 -Метод запроса **GET** 1877 - 1878 -(% style="text-align: left;" %) 1879 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1880 - 1881 -(% style="text-align: left;" %) 1882 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1883 - 1884 -Ответ: 1885 - 1886 -{ 1887 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1888 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1889 - "message": "string" ~/~/ текст описывающий статус. 1890 -} 1891 - 1892 1892 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1893 1893 1894 1894 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1925,10 +1925,12 @@ 1925 1925 { 1926 1926 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1927 1927 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1928 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1929 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1930 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1931 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2464 + "mileage": 0, ~/~/ Пробег за период, километры 2465 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2466 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2467 + "motohours": 0, ~/~/ Моточасы за период, секунды 2468 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2469 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1932 1932 } 1933 1933 ] 1934 1934 } ... ... @@ -1977,6 +1977,12 @@ 1977 1977 } 1978 1978 ] 1979 1979 2518 +(% class="box warningmessage" %) 2519 +((( 2520 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2521 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2522 +))) 2523 + 1980 1980 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1981 1981 1982 1982 (% class="box infomessage" %) ... ... @@ -2022,6 +2022,96 @@ 2022 2022 } 2023 2023 ] 2024 2024 2569 + 2570 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2571 + 2572 +(% class="box infomessage" %) 2573 +((( 2574 +**POST /api/v3/vehicles/moveStop** 2575 +))) 2576 + 2577 +Метод запроса: **POST** 2578 + 2579 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2580 + 2581 +В заголовках запроса: X-Auth: Токен авторизации 2582 + 2583 + 2584 +Тело запроса: 2585 + 2586 +{ 2587 + "vehicleIds": [ ], ~/~/ Список ID объектов 2588 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2589 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2590 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2591 +} 2592 + 2593 +Ответ: 2594 + 2595 +[ 2596 + { 2597 + "vehicleId": 0, ~/~/ ID объекта 2598 + "vehicleName": "string", ~/~/ Имя объекта 2599 + "moves": [ ~/~/ Событие движения 2600 + { 2601 + "mileage": 0, ~/~/ Пробег, км 2602 + "eventId": 0, ~/~/ Идентификатор события 2603 + "eventName": "string", ~/~/ Название события 2604 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2605 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2606 + "duration": 0 ~/~/ Продолжительность события, секунд 2607 + } 2608 + ], 2609 + "stops": [ ~/~/ События стоянок 2610 + { 2611 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2612 + "eventId": 0, ~/~/ Идентификатор события 2613 + "eventName": "string", ~/~/ Название события 2614 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2615 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2616 + "duration": 0 ~/~/ Продолжительность события, секунд 2617 + } 2618 + ] 2619 + } 2620 +] 2621 + 2622 + 2623 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2624 + 2625 +(% class="box infomessage" %) 2626 +((( 2627 +**POST /api/v3/vehicles/getlastdata** 2628 +))) 2629 + 2630 +Метод запроса: **POST** 2631 + 2632 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2633 + 2634 +В заголовках запроса: X-Auth: Токен авторизации 2635 + 2636 + 2637 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2638 + 2639 +Ответ: 2640 + { 2641 + "vehicleId": 0, ~/~/Идентификатор объекта. 2642 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2643 + "vehicleNumber": "string",~/~/Номер объекта. 2644 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2645 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2646 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2647 + "speed": 0,~/~/Скорость объекта. 2648 + "course": 0,~/~/Курс движения [0;360] 2649 + "latitude": 0,~/~/Широта [-90°;90°]. 2650 + "longitude": 0,~/~/Долгота [-180°;180°]. 2651 + "address": "string",~/~/Адрес. 2652 + "geozones": [ ~/~/Сведения по геозонам. 2653 + { 2654 + "id": 0, 2655 + "name": "string" 2656 + } 2657 + 2658 + 2025 2025 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2026 2026 2027 2027 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2329,6 +2329,32 @@ 2329 2329 2330 2330 Success 2331 2331 2966 + 2967 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2968 + 2969 +(% class="box warningmessage" %) 2970 +((( 2971 +**PUT** /api/v3/notifications/prolongation 2972 +))) 2973 + 2974 +Метод позволяет продлить уведомления. 2975 + 2976 +Метод запроса **PUT** 2977 + 2978 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2979 + 2980 +В заголовках запроса: X-Auth: Токен авторизации. 2981 + 2982 +Тело запроса: 2983 + 2984 +[ 2985 + 2986 +0 2987 + 2988 +] 2989 + 2990 +где 0 идентификатор ids. 2991 + 2332 2332 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2333 2333 2334 2334 (% class="box errormessage" %) ... ... @@ -2920,6 +2920,83 @@ 2920 2920 Success 2921 2921 2922 2922 3583 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3584 + 3585 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3586 + 3587 +(% class="box infomessage" %) 3588 +((( 3589 +**POST /api/v3/Trailers** 3590 +))) 3591 + 3592 +Пример запроса: 3593 + 3594 +{ 3595 + "startDate": "2023-11-14T10:48:03.671Z", 3596 + "endDate": "2023-11-14T10:48:03.671Z", 3597 + "ids": [ 0 ], 3598 + "timezone": 0 3599 +} 3600 + 3601 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3602 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3603 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3604 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3605 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3606 + 3607 +Пример ответа: 3608 + 3609 +[ 3610 + { 3611 + "SD": "2023-11-14T10:48:03.717Z", 3612 + "ED": "2023-11-14T10:48:03.717Z", 3613 + "id": 0, 3614 + "SLat": 0, 3615 + "SLon": 0, 3616 + "ELat": 0, 3617 + "ELon": 0, 3618 + "mileage": 0 3619 + "Duration": 0 3620 + "Address": "string", 3621 + "Address2": "string", 3622 + "name": "string", 3623 + "rid": "string", 3624 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3625 + "trailer": { 3626 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3627 + "Number": "string", 3628 + "Description": "string", 3629 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3630 + "ExternalID": "string", 3631 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3632 + "CreateTime": "2023-11-14T10:48:03.717Z", 3633 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3634 + "IsDeleted": true 3635 + }, 3636 + "filesCount": 0, 3637 + } 3638 +] 3639 + 3640 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3641 +|SD|Дата и время начала события 3642 +|ED|Дата и время окончания события 3643 +|id|ID объекта 3644 +|SLat|Широта начальной координаты 3645 +|SLon|Долгота начальной координаты 3646 +|ELat|Широта конечной координаты 3647 +|ELon|Долгота конечной координаты 3648 +|mileage|Пробег 3649 +|Duration|Продолжительность 3650 +|Address|Адрес начального местоположения 3651 +|Address2|Адрес конечного местоположения 3652 +|name|Имя радиометки 3653 +|rid|Номер радиометки 3654 +|rguid|ID радиометки 3655 +|trailer|Информация об агрегате 3656 +|ModelGuid|ID агрегата 3657 +|Number|Название/номер агрегата 3658 +|Description|Текст примечания агрегата 3659 + 2923 2923 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2924 2924 2925 2925 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2941,13 +2941,18 @@ 2941 2941 { 2942 2942 "name": "string", 2943 2943 "number": 0, 2944 - "period": 0, ~/~/ Частота трансляции радиометки3681 + "period": 0, 2945 2945 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2946 2946 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2947 - "deleted": true 2948 2948 } 2949 2949 ] 2950 2950 3687 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3688 +|parentId|ID клиента 3689 +|name|Название карты-метки 3690 +|number|Номер 3691 +|period|Период запросов в секундах (работает только для агрегатов) 3692 +|id|ID карты-метки 2951 2951 2952 2952 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2953 2953 ... ... @@ -2964,13 +2964,18 @@ 2964 2964 { 2965 2965 "name": "string", 2966 2966 "number": 0, 2967 - "period": 0, ~/~/ Частота трансляции радиометки3709 + "period": 0, 2968 2968 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2969 2969 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2970 - "deleted": true 2971 2971 } 2972 2972 ] 2973 2973 3715 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3716 +|name|Название карты-метки 3717 +|number|Номер 3718 +|period|Период запросов в секундах (работает только для агрегатов) 3719 +|id|ID карты-метки 3720 +|parentId|ID клиента 2974 2974 2975 2975 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2976 2976 ... ... @@ -2986,7 +2986,6 @@ 2986 2986 "number": 0, 2987 2987 "period": 0, 2988 2988 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2989 - "deleted": true 2990 2990 } 2991 2991 2992 2992 Ответ: ... ... @@ -2997,9 +2997,14 @@ 2997 2997 "period": 0, 2998 2998 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2999 2999 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3000 - "deleted": true 3001 3001 } 3002 3002 3748 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3749 +|name|Название карты-метки 3750 +|number|Номер 3751 +|period|Период запросов в секундах (работает только для агрегатов) 3752 +|id|ID карты-метки 3753 +|parentId|ID клиента 3003 3003 3004 3004 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3005 3005 ... ... @@ -3016,7 +3016,6 @@ 3016 3016 "period": 0, 3017 3017 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3018 3018 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3019 - "deleted": true 3020 3020 } 3021 3021 3022 3022 Ответ: ... ... @@ -3027,9 +3027,14 @@ 3027 3027 "period": 0, 3028 3028 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3029 3029 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3030 - "deleted": true 3031 3031 } 3032 3032 3782 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3783 +|name|Название карты-метки 3784 +|number|Номер 3785 +|period|Период запросов в секундах (работает только для агрегатов) 3786 +|id|ID карты-метки 3787 +|parentId|ID клиента 3033 3033 3034 3034 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3035 3035 ... ... @@ -3038,7 +3038,7 @@ 3038 3038 **DELETE /api/v3/Rfids/{rfidGuid}** 3039 3039 ))) 3040 3040 3041 -Передаем параметр rfidGuid - идентификатор карты-метки 3796 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3042 3042 3043 3043 Ответ: 3044 3044 ... ... @@ -3045,6 +3045,1688 @@ 3045 3045 Success 3046 3046 3047 3047 3803 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3804 + 3805 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3806 + 3807 +(% class="box infomessage" %) 3808 +((( 3809 +**GET /api/v3/Billing/client/balance/{clientId}** 3810 +))) 3811 + 3812 +Параметр запроса: **clientId **- идентификатор клиента. 3813 + 3814 +Ответ: 3815 + 3816 +{ 3817 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3818 + "Balance": 0 3819 +} 3820 + 3821 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3822 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3823 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3824 + 3825 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3826 + 3827 +(% class="box infomessage" %) 3828 +((( 3829 +**GET /api/v3/Billing/client/constraint/{clientId}** 3830 +))) 3831 + 3832 +Параметр запроса: **clientId **- идентификатор клиента. 3833 + 3834 +Ответ: 3835 + 3836 +{ 3837 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3838 + "CalculationType": 0, 3839 + "PermissibleBalance": 0, 3840 + "DefermentDays": 0, 3841 + "SendUiNotifications": true, 3842 + "SendEmailNotifications": true, 3843 + "IsPrivate": true, 3844 +} 3845 + 3846 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3847 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3848 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3849 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3850 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3851 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3852 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3853 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3854 + 3855 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3856 + 3857 +(% class="box infomessage" %) 3858 +((( 3859 +**GET /api/v3/Billing/client/plan/{clientId}** 3860 +))) 3861 + 3862 +Параметры запроса: 3863 + 3864 +**clientId **- идентификатор клиента. 3865 + 3866 +**planId **- идентификатор тарифного плана. 3867 + 3868 +Ответ: 3869 + 3870 +{ 3871 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3872 + "Plan": { **~/~/ Описание тарифного плана** 3873 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3874 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3875 + "Name": "string", 3876 + "IsArchived": true, 3877 + "Constraint": { 3878 + "CalculationType": 0, 3879 + "PermissibleBalance": 0, 3880 + "DefermentDays": 0 3881 + }, 3882 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3883 + { 3884 + "Feature": "string", 3885 + "IsFactual": true, 3886 + "Limit": 0, 3887 + "Price": 0, 3888 + "PeriodValue": 0, 3889 + "PeriodType": 0 3890 + } 3891 + ] 3892 + }, 3893 + "DebitDate": "2023-10-18T12:46:24.213Z", 3894 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3895 + { 3896 + "Feature": "string", 3897 + "IsEnabled": true, 3898 + "IsPrivate": true, 3899 + "IsFactual": true, 3900 + "Limit": 0, 3901 + "Price": 0, 3902 + "DebitDate": "2023-10-18T12:46:24.213Z", 3903 + "PeriodValue": 0, 3904 + "PeriodType": 0 3905 + } 3906 + ] 3907 +} 3908 + 3909 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3910 +|ClientId|Идентификатор клиента 3911 +|Id|Идентификатор тарифного плана 3912 +|OwnerId|Идентификатор клиента-владельца 3913 +|Name|Наименование тарифного плана 3914 +|IsArchived|Признак, определяющий архивный тарифный план 3915 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3916 +|PermissibleBalance|Допустимый баланс 3917 +|DefermentDays|Отсрочка, количество дней 3918 +|Feature|Код услуги 3919 +|IsEnabled|Признак, определяющий активирована ли услуга 3920 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3921 +|IsFactual|Признак, определяющий расчёт по факту 3922 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3923 +|Price|Цена за единицу. 3924 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3925 +|PeriodValue|Значение периода. 3926 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3927 + 3928 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3929 + 3930 +(% class="box infomessage" %) 3931 +((( 3932 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3933 +))) 3934 + 3935 +Параметр запроса: **clientId **- идентификатор клиента. 3936 + 3937 +Ответ: 3938 + 3939 +[ 3940 + { 3941 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3942 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3943 + "Name": "string", 3944 + "IsArchived": true, 3945 + "Constraint": { 3946 + "CalculationType": 0, 3947 + "PermissibleBalance": 0, 3948 + "DefermentDays": 0 3949 + }, 3950 + "Features": [ 3951 + { 3952 + "Feature": "string", 3953 + "IsFactual": true, 3954 + "Limit": 0, 3955 + "Price": 0, 3956 + "PeriodValue": 0, 3957 + "PeriodType": 0 3958 + } 3959 + ] 3960 + } 3961 +] 3962 + 3963 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3964 +|ClientId|Идентификатор клиента 3965 +|Id|Идентификатор тарифного плана 3966 +|OwnerId|Идентификатор клиента-владельца 3967 +|Name|Наименование тарифного плана 3968 +|IsArchived|Признак, определяющий архивный тарифный план 3969 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3970 +|PermissibleBalance|Допустимый баланс 3971 +|DefermentDays|Отсрочка, количество дней 3972 +|Feature|Код услуги 3973 +|IsFactual|Признак, определяющий расчёт по факту 3974 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3975 +|Price|Цена за единицу. 3976 +|PeriodValue|Значение периода. 3977 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3978 + 3979 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3980 + 3981 +(% class="box infomessage" %) 3982 +((( 3983 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3984 +))) 3985 + 3986 +Параметр запроса: **clientId **- идентификатор клиента. 3987 + 3988 +Ответ: 3989 + 3990 +[ 3991 + { 3992 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3993 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3994 + "Name": "string", 3995 + "IsArchived": true, 3996 + "Constraint": { 3997 + "CalculationType": 0, 3998 + "PermissibleBalance": 0, 3999 + "DefermentDays": 0 4000 + }, 4001 + "Features": [ 4002 + { 4003 + "Feature": "string", 4004 + "IsFactual": true, 4005 + "Limit": 0, 4006 + "Price": 0, 4007 + "PeriodValue": 0, 4008 + "PeriodType": 0 4009 + } 4010 + ] 4011 + } 4012 +] 4013 + 4014 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4015 +|ClientId|Идентификатор клиента 4016 +|Id|Идентификатор тарифного плана 4017 +|OwnerId|Идентификатор клиента-владельца 4018 +|Name|Наименование тарифного плана 4019 +|IsArchived|Признак, определяющий архивный тарифный план 4020 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4021 +|PermissibleBalance|Допустимый баланс 4022 +|DefermentDays|Отсрочка, количество дней 4023 +|Feature|Код услуги 4024 +|IsFactual|Признак, определяющий расчёт по факту 4025 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4026 +|Price|Цена за единицу. 4027 +|PeriodValue|Значение периода. 4028 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4029 + 4030 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4031 + 4032 +(% class="box warningmessage" %) 4033 +((( 4034 +**PUT /api/v3/Billing/client/balance** 4035 +))) 4036 + 4037 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4038 + 4039 +Тело запроса: 4040 + 4041 +{ 4042 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4043 + "Balance": 0 4044 +} 4045 + 4046 +Ответ: Success 4047 + 4048 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4049 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4050 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4051 + 4052 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4053 + 4054 +(% class="box warningmessage" %) 4055 +((( 4056 +**PUT /api/v3/billing/client/balance/deposit** 4057 +))) 4058 + 4059 +Создает операцию **Пополнение **с указанной суммой 4060 + 4061 +Тело запроса: 4062 + 4063 +{ 4064 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4065 + "Balance": 0 4066 +} 4067 + 4068 +Ответ: Success 4069 + 4070 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4071 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4072 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4073 + 4074 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4075 + 4076 +Создает операцию **Списание **с указанной суммой 4077 + 4078 +(% class="box warningmessage" %) 4079 +((( 4080 +**PUT /api/v3/billing/client/balance/withdraw** 4081 +))) 4082 + 4083 +Тело запроса: 4084 + 4085 +{ 4086 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4087 + "Balance": 0 4088 +} 4089 + 4090 +Ответ: Success 4091 + 4092 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4093 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4094 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4095 + 4096 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4097 + 4098 +(% class="box warningmessage" %) 4099 +((( 4100 +**PUT /api/v3/Billing/client/constraint** 4101 +))) 4102 + 4103 +Тело запроса: 4104 + 4105 +{ 4106 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4107 + "CalculationType": 0, 4108 + "PermissibleBalance": 0, 4109 + "DefermentDays": 0, 4110 + "SendUiNotifications": true, 4111 + "SendEmailNotifications": true, 4112 + "IsPrivate": true, 4113 +} 4114 + 4115 +Ответ: Success 4116 + 4117 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4118 +|ClientId|Идентификатор клиента 4119 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4120 +|PermissibleBalance|Допустимый баланс 4121 +|DefermentDays|((( 4122 +Отсрочка, количество дней 4123 +))) 4124 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 4125 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 4126 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4127 + 4128 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4129 + 4130 +(% class="box warningmessage" %) 4131 +((( 4132 +**PUT /api/v3/Billing/client/plan** 4133 +))) 4134 + 4135 +Тело запроса: 4136 + 4137 +{ 4138 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4139 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4140 + "Features": [ 4141 + { 4142 + "Feature": "string", 4143 + "IsEnabled": true, 4144 + "IsFactual": true, 4145 + "Limit": 0, 4146 + "Price": 0, 4147 + "DebitDate": "2023-10-18T13:26:58.987Z", 4148 + "PeriodValue": 0, 4149 + "PeriodType": 0 4150 + } 4151 + ] 4152 +} 4153 + 4154 +Ответ: Success 4155 + 4156 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4157 +|ClientId|Идентификатор клиента 4158 +|PlanId|Идентификатор тарифного плана 4159 +|Feature|Код услуги 4160 +|IsEnabled|Признак, определяющий активирована ли услуга 4161 +|IsFactual|Признак, определяющий расчёт по факту 4162 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4163 +|Price|Цена за единицу. 4164 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4165 +|PeriodValue|Значение периода. 4166 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4167 + 4168 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4169 + 4170 +(% class="box warningmessage" %) 4171 +((( 4172 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4173 +))) 4174 + 4175 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4176 + 4177 +(% class="box infomessage" %) 4178 +((( 4179 +**POST /api/v3/vehicles/import/{agentId}** 4180 +))) 4181 + 4182 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4183 + 4184 +В пути указывается **agentId** - id клиента. 4185 + 4186 +**Заголовок** 4187 + 4188 +**X-Auth: [токен авторизации]** 4189 + 4190 +**Параметры** 4191 + 4192 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4193 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4194 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4195 + 4196 +В теле использовать тип **form-data,** тип значения** file** 4197 + 4198 +**Ключи** 4199 + 4200 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4201 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4202 +|csv|В значении передаем файл датчиков, формат **csv** 4203 + 4204 +Ответ: 4205 + 4206 +{ 4207 + "vehicleId": 0, 4208 + "name": "string", 4209 + "errors": ["string"] 4210 +} 4211 + 4212 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4213 +|vehicleId|ID созданного объекта 4214 +|name|Имя созданного объекта 4215 +|errors|Ошибки и их описание 4216 + 4217 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4218 + 4219 +(% class="box infomessage" %) 4220 +((( 4221 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4222 +))) 4223 + 4224 +(% class="wikigeneratedid" %) 4225 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4226 + 4227 +(% class="wikigeneratedid" %) 4228 +В пути указывается **vehicleId **- id объекта. 4229 + 4230 +**Заголовок** 4231 + 4232 +**X-Auth: [токен авторизации]** 4233 + 4234 +В теле использовать тип **form-data.** 4235 + 4236 +Ключи: 4237 + 4238 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4239 +|**history**|В значении передавать файл с историей 4240 + 4241 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4242 + 4243 +Ответ: 4244 + 4245 +{ 4246 + "results": [ 4247 + { 4248 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4249 + "vehicleId": 0, 4250 + "errors": [ 4251 + "string" 4252 + ], 4253 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4254 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4255 + "producedCount": 0, 4256 + "msgCount": 0 4257 + } 4258 + ] 4259 +} 4260 + 4261 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4262 +|results|Результаты импорта в разрезе ТС 4263 +|vehicleGuid|Guid ТС 4264 +|vehicleId|ID ТС 4265 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4266 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4267 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4268 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4269 +|msgCount|Кол-во обработанных сообщений всего 4270 + 4271 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4272 + 4273 +(% class="box infomessage" %) 4274 +((( 4275 +**GET /api/v3/vehicles/import/history/status** 4276 +))) 4277 + 4278 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4279 + 4280 +Ответ: 4281 + 4282 +{ 4283 + "activity": true, 4284 + "progress": 0, 4285 + "message": "string" 4286 +} 4287 + 4288 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4289 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4290 +|progress|Guid ТС 4291 + 4292 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4293 + 4294 +(% class="box infomessage" %) 4295 +((( 4296 +**POST /api/v3/vehicles/export** 4297 +))) 4298 + 4299 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4300 + 4301 +Тело запроса: 4302 + 4303 +[ 4304 + id 4305 +] 4306 + 4307 +Ответ: Success 200, получаете файлы с настройками. 4308 + 4309 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4310 + 4311 +(% class="box infomessage" %) 4312 +((( 4313 +**POST /api/v3/vehicles/export/history** 4314 +))) 4315 + 4316 +Метод возвращает список сообщений терминала объекта за выбранный период. 4317 + 4318 +Тело запроса: 4319 + 4320 +{ 4321 + "vehicleId": 0, 4322 + "asArchive": true, 4323 + "from": "2023-09-27T12:17:45.973Z", 4324 + "to": "2023-09-27T12:17:45.973Z" 4325 +} 4326 + 4327 +Ответ: 4328 + 4329 +Получаете файл. Сообщение: Code 200/Success 4330 + 4331 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4332 +|vehicleId|ID объекта 4333 +|asArchive|true - Архивировать файл, False - не архивировать 4334 +|from|Дата и время начала запроса 4335 +|to|Дата и время окончания запроса 4336 + 4337 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4338 + 4339 +(% class="box infomessage" %) 4340 +((( 4341 +**GET /api/v3/vehicles/export/history/status** 4342 +))) 4343 + 4344 +Метод возвращает список сообщений терминала объекта за выбранный период. 4345 + 4346 +Ответ: 4347 + 4348 +{ 4349 + "activity": true, 4350 + "progress": 0, 4351 + "message": "string" 4352 +} 4353 + 4354 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4355 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4356 +|progress|Прогресс экспорта, от 0 до 100% 4357 +|message|Текст описывающий статус 4358 + 4359 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4360 + 4361 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4362 + 4363 +(% class="box infomessage" %) 4364 +((( 4365 +**POST /api/v3/EcoDriving/rating** 4366 +))) 4367 + 4368 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4369 + 4370 +Тело запроса: 4371 + 4372 +{ 4373 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4374 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4375 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4376 +} 4377 + 4378 +Ответ: 4379 + 4380 +{ 4381 + "items": [ ~/~/ Список в разрезе ТС 4382 + { 4383 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4384 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4385 + "vehicleId": 0, ~/~/ ID ТС 4386 + "vehicleName": "string", ~/~/ Название ТС 4387 + "vehicleModel": "string", ~/~/ Модель ТС 4388 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4389 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4390 + "totalViolations": 0, ~/~/ Нарушений всего 4391 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4392 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4393 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4394 + "brakingViolations": 0, ~/~/ Нарушений торможения 4395 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4396 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4397 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4398 + }, 4399 + 4400 +((( 4401 + 4402 +))) 4403 + 4404 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4405 + "mileage": 0, ~/~/ Пробег, м 4406 + "tripsCount": 0, ~/~/ Кол-во рейсов 4407 + "trips": [ ~/~/ Информация по рейсу 4408 + { 4409 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4410 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4411 + "violationsCount": 0, ~/~/ Всего нарушений 4412 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4413 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4414 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4415 + "brakingViolations": 0, ~/~/ Нарушений торможения 4416 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4417 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4418 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4419 + }, 4420 + 4421 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4422 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4423 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4424 + "mileage": 0, ~/~/ Пробег, м 4425 + "motohours": 0, ~/~/ Моточасы, секунды 4426 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4427 + "startAddress": "string", ~/~/ Адрес начала рейса 4428 + "endAddress": "string", ~/~/ Адрес конца рейса 4429 + "drivers": [ ~/~/ Список водителей 4430 + { 4431 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4432 + "driverName": "string", ~/~/ФИО водителя 4433 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4434 + } 4435 + ] 4436 + } 4437 + ] 4438 + } 4439 + ] 4440 +} 4441 + 4442 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4443 + 4444 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4445 + 4446 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4447 + 4448 +(% class="box infomessage" %) 4449 +((( 4450 +**POST /api/v3/fuelcards/transactions** 4451 +))) 4452 + 4453 +Метод запроса: POST 4454 + 4455 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4456 +\\В заголовках запроса: X-Auth: Токен авторизации 4457 + 4458 +Параметры в теле запроса (JSON): 4459 + 4460 +{ 4461 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4462 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4463 + "ids": [ 4464 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4465 + ], 4466 + "timezone": 0 ~/~/ Часовой пояс 4467 +} 4468 + 4469 + 4470 +Ответ: 4471 + { 4472 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4473 + "driver": "string", ~/~/ Водители, привязанные к ТК 4474 + "object": "string", ~/~/ Наименование ТС 4475 + "amount": 0, ~/~/ Количество топлива 4476 + "amountDut": 0, ~/~/ Количество по ДУТ 4477 + "amountDiff": 0, ~/~/ Разница, л 4478 + "amountDiffPerc": 0, ~/~/ Разница, % 4479 + "summa": 0, ~/~/ Стоимость, руб 4480 + "serviceName": "string", ~/~/ Тип топлива 4481 + "price": 0, ~/~/ Цена за литр, руб 4482 + "cardName": "string", ~/~/ Наименование ТК 4483 + "cardNum": "string", ~/~/ Номер ТК 4484 + "operator": "string", ~/~/ Оператор ТК 4485 + "address": "string" ~/~/ Адрес АЗС 4486 + } 4487 + 4488 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4489 + 4490 +(% class="box infomessage" %) 4491 +((( 4492 +**GET /api/v3/fuelcards** 4493 +))) 4494 + 4495 +Метод запроса: GET 4496 + 4497 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4498 + 4499 +Ответ: 4500 + 4501 +[ 4502 + { 4503 + "Name": "string", ~/~/ Определяет наименование карты. 4504 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4505 + "Number": "string", ~/~/ Определяет № карты. 4506 + "Enabled": true, ~/~/ Определяет признак активности карты. 4507 + "Description": "string", ~/~/ Определяет описание карты. 4508 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4509 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4510 + "deleted": true ~/~/ Признак удаления 4511 + } 4512 +] 4513 + 4514 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4515 + 4516 + 4517 +== **Получение полных данных о ретрансляторе** == 4518 + 4519 +(% class="box infomessage" %) 4520 +((( 4521 +**GET ** **/api/v3/retranslations/{id}** 4522 +))) 4523 + 4524 +id - Идентификатор ретранслятора 4525 + 4526 + 4527 +Пример ответа: 4528 + 4529 +{ 4530 +"description": "", ~/~/ Поле описания ретранслятора 4531 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4532 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4533 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4534 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4535 +"objects": [ ~/~/ Объекты для ретрансляции 4536 +{ 4537 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4538 +"name": "", ~/~/ Наименование объекта ретрансляции 4539 +"imei": "", ~/~/ IMEI объекта ретрансляции 4540 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4541 +} 4542 + ], 4543 +"id": "", ~/~/ Идентификатор ретранслятора 4544 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4545 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4546 +} 4547 + 4548 + 4549 +== **Удаление данных ретранслятора** == 4550 + 4551 +(% class="box infomessage" %) 4552 +((( 4553 +**DELETE** **/api/v3/retranslations/{id}** 4554 +))) 4555 + 4556 +id - Идентификатор ретранслятора 4557 + 4558 + 4559 +== **Создание ретранслятора** == 4560 + 4561 +(% class="box infomessage" %) 4562 +((( 4563 +**POST ** **/api/v3/retranslations/{id}** 4564 +))) 4565 + 4566 +Запрос: 4567 + 4568 +{ 4569 +"description": "", ~/~/ Поле описания ретранслятора 4570 +"subscriberId": "", ~/~/ Идентификатор подписчика 4571 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4572 +"address": "", ~/~/ Адрес и порт принимающего сервера 4573 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4574 +"objects": [ ~/~/Объекты для ретрансляции 4575 +{ 4576 +"id": "", ~/~/ Идентификатор ретранслятора 4577 +"imei": "", ~/~/ IMEI объекта ретрансляции 4578 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4579 +} 4580 + ] 4581 +} 4582 + 4583 + 4584 +Ответ: 4585 + 4586 +{ 4587 +"description": "", ~/~/ Поле описания ретранслятора 4588 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4589 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4590 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4591 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4592 +"objects": [ ~/~/ Объекты для ретрансляции 4593 +{ 4594 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4595 +"name": "string", ~/~/ Наименование объекта ретрансляции 4596 +"imei": "", ~/~/ IMEI объекта ретрансляции 4597 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4598 +} 4599 + ], 4600 +"id": "", ~/~/ Идентификатор ретранслятора 4601 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4602 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4603 +} 4604 + 4605 + 4606 +== **Редактирование ретранслятора** == 4607 + 4608 +(% class="box infomessage" %) 4609 +((( 4610 +**PUT** **/api/v3/retranslations** 4611 +))) 4612 + 4613 +Пример запроса: 4614 + 4615 +{ 4616 +"id": "", ~/~/ Идентификатор ретранслятора 4617 +"description": "string", ~/~/ Поле описания ретранслятора 4618 +"subscriberId": "", ~/~/ Идентификатор подписчика 4619 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4620 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4621 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4622 +"objects": ~/~/ Объекты для ретрансляции 4623 +[ 4624 +{ 4625 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4626 +"imei": "", ~/~/ IMEI объекта ретрансляции 4627 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4628 +} 4629 + ] 4630 +} 4631 + 4632 + 4633 +Пример ответа: 4634 + 4635 +{ 4636 +"description": "", ~/~/ Поле описания ретранслятора 4637 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4638 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4639 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4640 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4641 +"objects": [ ~/~/ Объекты для ретрансляции 4642 +{ 4643 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4644 +"name": "string", ~/~/ Наименование объекта ретрансляции 4645 +"imei": "", ~/~/ IMEI объекта ретрансляции 4646 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4647 +} 4648 + ], 4649 +"id": "", ~/~/ Идентификатор ретранслятора 4650 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4651 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4652 +} 4653 + 4654 + 4655 +== **Получение списка ретранслятора клиента** == 4656 + 4657 +(% class="box infomessage" %) 4658 +((( 4659 +**POST /api/v3/retranslations/find** 4660 +))) 4661 + 4662 +Пример запроса: 4663 + 4664 +{ 4665 +"id": "", ~/~/ Идентификатор ретранслятора 4666 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4667 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4668 +} 4669 + 4670 +Ответ: 4671 + 4672 +[ 4673 +{ 4674 +"description": "", ~/~/ Поле описания ретранслятора 4675 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4676 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4677 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4678 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4679 +"id": "", ~/~/ Идентификатор ретранслятора 4680 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4681 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4682 +} 4683 +] 4684 + 4685 + 4686 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4687 + 4688 +== **API для отчета по выгрузке комбайнов** == 4689 + 4690 +(% class="box infomessage" %) 4691 +((( 4692 +**POST /api/v3/Reports/harvesterUnloading** 4693 +))) 4694 + 4695 +Пример запроса: 4696 + 4697 +{ 4698 + "byTime": 0, ~/~/ Объединение событий по времени 4699 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4700 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4701 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4702 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4703 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4704 + 0 4705 + ], 4706 + "from": "", ~/~/ Дата и время начало запроса 4707 + "to": "", ~/~/ Дата и время окончания запроса 4708 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4709 +} 4710 + 4711 +Пример ответа: 4712 + 4713 +[ 4714 + { 4715 + "harvesterName": "", ~/~/Комбайн, номер 4716 + "harvesterId": 0, ~/~/Комбайн, id 4717 +"harvesterModel": "", ~/~/ Модель комбайна 4718 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4719 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4720 + "events": [ ~/~/Список событий в разрезе комбайна 4721 + { 4722 + "driverId": "", ~/~/Идентификатор водителя 4723 + "driverName": "", ~/~/Водитель комбайна, ФИО 4724 + "RFID": "", ~/~/ идентификатор карты-метки 4725 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4726 + "vehicleId": 0, ~/~/идентификатор объекта 4727 + "vehicleName": "string", ~/~/ Имя объекта 4728 + "modelName": "string", ~/~/ Имя модели объекта 4729 + "nearestVehicles": [ ~/~/Объекты рядом 4730 + { 4731 + "vehicleId": 0, ~/~/идентификатор объекта 4732 + "vehicleName": "string" ~/~/ Имя объекта 4733 + } 4734 + ], 4735 + "fields": [ ~/~/Поля, где происходила выгрузка 4736 + { 4737 + "id": 0, ~/~/ идентификатор пользователя 4738 + "name": "string" ~/~/ имя пользователя 4739 + } 4740 + ], 4741 + "event": "string", ~/~/Событие 4742 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4743 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4744 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4745 + "cultureName": "string", ~/~/ название культуры 4746 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4747 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4748 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4749 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4750 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4751 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4752 + "issued": 0, ~/~/Выдано, бункеров 4753 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4754 + "latitude": 0, ~/~/Широта 4755 + "longitude": 0, ~/~/ Долгота 4756 + "litresAway": 0, ~/~/Отдано, л 4757 + "m3Away": 0 ~/~/Отдано, м3 4758 + } 4759 + ] 4760 + } 4761 +] 4762 + 4763 + 4764 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4765 + 4766 + 4767 +== **Запрос списка полей** == 4768 + 4769 +(% class="box successmessage" %) 4770 +((( 4771 +**POST /api/v3/agroLands/find** 4772 +))) 4773 + 4774 +Пример запроса: 4775 + 4776 +((( 4777 +((( 4778 +((( 4779 +{ 4780 + "year": 0, ~/~/ Фильтр по году 4781 + "name": "string", ~/~/ Фильтр по названию 4782 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4783 +} 4784 +))) 4785 +))) 4786 + 4787 + 4788 +))) 4789 + 4790 +Пример ответа: 4791 + 4792 +((( 4793 +[ 4794 + { 4795 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4796 + "year": 0, ~/~/ Год поля 4797 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4798 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4799 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4800 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4801 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4802 + "counts": { ~/~/ Счётчики с/х поля 4803 + "fieldOperations": 0, ~/~/ Количество операций на поле 4804 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4805 + "facts": 0 ~/~/ Счётчик факта 4806 + }, 4807 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4808 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4809 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4810 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4811 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4812 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4813 + "planComment": "string", ~/~/ Комментарий к полю 4814 + "productivity": 0, ~/~/ Урожайность. 4815 + "id": 0, ~/~/ Идентификатор объекта геозоны 4816 + "name": "string", ~/~/ Название объекта геозоны 4817 + "type": 0, ~/~/ Тип объекта геозоны 4818 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4819 + "fname": "string", ~/~/ Имя файла 4820 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4821 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4822 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4823 + "description": "string", ~/~/ Описание объекта геозоны 4824 + "area": 0, ~/~/ Площадь, м2 4825 + "perimetr": 0, ~/~/ Периметр, м 4826 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4827 + } 4828 +] 4829 + 4830 + 4831 +== **Создание нового поля ** == 4832 + 4833 +(% class="box successmessage" %) 4834 +((( 4835 +**POST /api/v3/agroLands** 4836 +))) 4837 + 4838 +Пример запроса: 4839 + 4840 +((( 4841 +{ 4842 + "extId": "string", 4843 + "shape": "string", ~/~/ Форма поля 4844 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4845 + "display": "string", ~/~/ Настройки отображения 4846 + "year": 0, ~/~/ Год поля 4847 + "name": "string", ~/~/ Наименование 4848 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4849 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4850 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4851 + "planComment": "string", ~/~/ Комментарий к полю 4852 + "cropRotations": [ ~/~/ Данные по севообороту 4853 + { 4854 + "landId": 0, ~/~/ ID поля 4855 + "landName": "string", ~/~/ Название поля 4856 + "year": 0, ~/~/ Год урожая 4857 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4858 + "cultureName": "string", ~/~/ Название культуры 4859 + "productivity": 0, ~/~/ Урожайность 4860 + "area": 0, ~/~/ Площадь поля, Га 4861 + "total": 0, ~/~/ Валовый сбор 4862 + "productivityFact": 0, ~/~/ Фактическая урожайность 4863 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4864 + "totalFact": 0, ~/~/ Фактический валовый сбор 4865 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4866 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4867 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4868 + "isyearplan": true, ~/~/ Годовой план 4869 + "comment": "string" ~/~/ Комментарий 4870 + } 4871 + ] 4872 +} 4873 +))) 4874 + 4875 +((( 4876 + 4877 +))) 4878 + 4879 +Пример ответа: 4880 + 4881 +((( 4882 +((( 4883 +{ 4884 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4885 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4886 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4887 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4888 + "cropRotations": [ ~/~/ Данные по севообороту 4889 + { 4890 + "landId": 0, ~/~/ ID поля 4891 + "landName": "string", ~/~/ Название поля 4892 + "year": 0, ~/~/ Год урожая 4893 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4894 + "cultureName": "string", ~/~/ Название культуры 4895 + "productivity": 0, ~/~/ Урожайность 4896 + "area": 0, ~/~/ Площадь поля, Га. 4897 + "total": 0, ~/~/ Валовый сбор 4898 + "productivityFact": 0, ~/~/ Фактическая урожайность 4899 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4900 + "totalFact": 0, ~/~/ Фактический валовый сбор 4901 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 4902 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 4903 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 4904 + "isyearplan": true, ~/~/ годовой план 4905 + "comment": "string" ~/~/ Комментарий 4906 + } 4907 + ], 4908 + "cropVegetation": [ ~/~/ История вегетации поля 4909 + { 4910 + "values": [ ~/~/ Данные вегетации и состояния посева 4911 + { 4912 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4913 + "ndvi": 0 ~/~/ Индекс вегетации 4914 + } 4915 + ], 4916 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4917 + { 4918 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4919 + "type": "string", ~/~/ Тип 4920 + "pictureid": "string" ~/~/ Идентификатор ресурса 4921 + } 4922 + ], 4923 + "states": [ ~/~/ Ключевые даты развития поля 4924 + { 4925 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4926 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 4927 + } 4928 + ] 4929 + } 4930 + ], 4931 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 4932 + "counts": { 4933 + "fieldOperations": 0, ~/~/ Количество операций на поле 4934 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4935 + "facts": 0 ~/~/ Счётчик факта 4936 + }, 4937 + "planComment": "string", ~/~/ Комментарий к полю 4938 +))) 4939 + 4940 +((( 4941 + "productivity": 0, ~/~/ Урожайность. 4942 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4943 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 4944 + "year": 0, ~/~/ Год поля 4945 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4946 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4947 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4948 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4949 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 4950 + "id": 0, ~/~/ Идентификатор объекта геозоны 4951 + "name": "string", ~/~/ Название объекта геозоны 4952 + "type": 0, ~/~/ Тип объекта геозоны 4953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4954 + "fname": "string", ~/~/ Имя файла 4955 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4956 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 4957 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 4958 + "description": "string", ~/~/ Описание объекта геозоны 4959 + "area": 0, ~/~/ Площадь, м2 4960 + "perimetr": 0, ~/~/ Периметр, м 4961 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 4962 +} 4963 + 4964 + 4965 +))) 4966 +))) 4967 +))) 4968 + 4969 +== **Получение поля по id** == 4970 + 4971 +(% class="box infomessage" %) 4972 +((( 4973 +**GET /api/v3/agroLands/{id}** 4974 +))) 4975 + 4976 +Пример запроса: 4977 +id ~/~/ Идентификатор поля 4978 + 4979 +Пример ответа: 4980 + 4981 +((( 4982 +{ 4983 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4984 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4985 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4986 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4987 + "cropRotations": [ ~/~/ Данные по севообороту 4988 + { 4989 + "landId": 0, ~/~/ ID поля 4990 + "landName": "string", ~/~/ Название поля 4991 + "year": 0, ~/~/ Год урожая 4992 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4993 + "cultureName": "string", ~/~/ Название культуры 4994 + "productivity": 0, ~/~/ Урожайность 4995 + "area": 0, ~/~/ Площадь поля, Га 4996 + "total": 0, ~/~/ Валовый сбор 4997 + "productivityFact": 0, ~/~/ Фактическая урожайность 4998 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4999 + "totalFact": 0, ~/~/ Фактический валовый сбор 5000 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5001 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5002 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5003 + "isyearplan": true, ~/~/ План года 5004 + "comment": "string" ~/~/ Комментарий 5005 + } 5006 + ], 5007 + "cropVegetation": [ ~/~/ История вегетации поля 5008 + { 5009 + "values": [ ~/~/ Данные вегетации и состояния посева 5010 + { 5011 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5012 + "ndvi": 0 ~/~/ Индекс вегетации 5013 + } 5014 + ], 5015 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5016 + { 5017 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5018 + "type": "string", ~/~/ Тип 5019 + "pictureid": "string" ~/~/ Идентификатор ресурса 5020 + } 5021 + ], 5022 + "states": [ ~/~/ Ключевые даты развития поля 5023 + { 5024 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5025 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5026 + } 5027 + ] 5028 + } 5029 + ], 5030 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5031 + "counts": { 5032 + "fieldOperations": 0, ~/~/ Количество операций на поле 5033 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5034 + "facts": 0 ~/~/ Счётчик факта 5035 + }, 5036 + "planComment": "string", ~/~/ Комментарий к полю 5037 + "productivity": 0, ~/~/ Урожайность. 5038 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5039 +))) 5040 + 5041 +((( 5042 +((( 5043 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5044 + "year": 0, ~/~/ Год поля 5045 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5046 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5047 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5048 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5049 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5050 + "id": 0, ~/~/ Идентификатор объекта геозоны 5051 + "name": "string", ~/~/ Название объекта геозоны 5052 + "type": 0, ~/~/ Тип объекта геозоны 5053 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5054 + "fname": "string", ~/~/ Имя файла 5055 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5056 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5057 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5058 + "description": "string", ~/~/ Описание объекта геозоны 5059 + "area": 0, ~/~/ Площадь, м2 5060 + "perimetr": 0, ~/~/ Периметр, м 5061 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5062 +} 5063 +))) 5064 + 5065 + 5066 +== **Удаление существующего поля** == 5067 + 5068 +(% class="box errormessage" %) 5069 +((( 5070 +**DELETE /api/v3/agroLands/{id}** 5071 +))) 5072 + 5073 +Пример запроса: 5074 +id ~/~/ Идентификатор поля 5075 + 5076 +Пример ответа: 5077 + 5078 +((( 5079 +200 ~/~/ Успех 5080 +))) 5081 + 5082 +((( 5083 + 5084 +))) 5085 + 5086 +((( 5087 +((( 5088 +((( 5089 + 5090 +))) 5091 + 5092 +((( 5093 +== **Изменение поля** == 5094 + 5095 +(% class="box infomessage" %) 5096 +((( 5097 +**PUT /api/v3/agroLands** 5098 +))) 5099 + 5100 +Пример запроса: 5101 + 5102 +((( 5103 +((( 5104 +{ 5105 + "id": 0, ~/~/ Идентификатор поля 5106 + "extId": "string", ~/~/ ExtId 5107 + "shape": "string", ~/~/ Форма поля 5108 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5109 + "display": "string", ~/~/ Настройки отображения 5110 + "year": 0, ~/~/ Год поля 5111 + "name": "string", ~/~/ Наименование 5112 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5113 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5114 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5115 + "planComment": "string", ~/~/Комментарий к полю 5116 + "cropRotations": [ ~/~/ Данные по севообороту 5117 + { 5118 + "landId": 0, ~/~/ ID поля 5119 + "landName": "string", ~/~/ Название поля 5120 + "year": 0, ~/~/ Год урожая 5121 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5122 + "cultureName": "string", ~/~/ Название культуры 5123 + "productivity": 0, ~/~/ Урожайность 5124 + "area": 0, ~/~/ Площадь поля, Га. 5125 + "total": 0, ~/~/ Валовый сбор 5126 + "productivityFact": 0, ~/~/ Фактическая урожайность 5127 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5128 + "totalFact": 0, ~/~/ Фактический валовый сбор 5129 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5130 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5131 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5132 + "isyearplan": true, 5133 + "comment": "string" ~/~/ Комментарий 5134 + } 5135 + ], 5136 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5137 +} 5138 +))) 5139 +))) 5140 + 5141 +((( 5142 + 5143 +))) 5144 + 5145 +Пример ответа: 5146 + 5147 +((( 5148 +((( 5149 +((( 5150 +{ 5151 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5152 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5153 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5154 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5155 + "cropRotations": [ ~/~/ Данные по севообороту 5156 + { 5157 + "landId": 0, ~/~/ ID поля 5158 + "landName": "string", ~/~/ Название поля 5159 + "year": 0, ~/~/ Год урожая 5160 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5161 + "cultureName": "string", ~/~/ Название культуры 5162 + "productivity": 0, ~/~/ Урожайность 5163 + "area": 0, ~/~/ Площадь поля, Га 5164 + "total": 0, ~/~/ Валовый сбор 5165 + "productivityFact": 0, ~/~/ Фактическая урожайность 5166 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5167 + "totalFact": 0, ~/~/ Фактический валовый сбор 5168 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5169 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5170 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5171 + "isyearplan": true, ~/~/ 5172 + "comment": "string" ~/~/ Комментарий 5173 + } 5174 + ], 5175 + "cropVegetation": [ ~/~/ История вегетации поля 5176 + { 5177 + "values": [ ~/~/ Данные вегетации и состояния посева 5178 + { 5179 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5180 + "ndvi": 0 ~/~/ Индекс вегетации 5181 + } 5182 + ], 5183 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5184 + { 5185 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5186 + "type": "string", ~/~/ Тип 5187 + "pictureid": "string" ~/~/ Идентификатор ресурса 5188 + } 5189 + ], 5190 + "states": [ ~/~/ Ключевые даты развития поля 5191 + { 5192 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5193 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5194 + } 5195 + ] 5196 + } 5197 + ], 5198 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5199 + "counts": { 5200 + "fieldOperations": 0, ~/~/ Количество операций на поле 5201 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5202 + "facts": 0 ~/~/ Счётчик факта 5203 + }, 5204 + "planComment": "string", ~/~/ Комментарий к полю 5205 + "productivity": 0, ~/~/ Урожайность. 5206 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5207 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5208 + "year": 0, ~/~/ Год поля 5209 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5210 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5211 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5212 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5213 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5214 + "id": 0, ~/~/ Идентификатор объекта геозоны 5215 + "name": "string", ~/~/ Название объекта геозоны 5216 + "type": 0, ~/~/ Тип объекта геозоны 5217 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5218 + "fname": "string", ~/~/ Имя файла 5219 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5220 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5221 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5222 + "description": "string", ~/~/ Описание объекта геозоны 5223 + "area": 0, ~/~/ Площадь, м2 5224 + "perimetr": 0, ~/~/ Периметр, м 5225 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5226 +} 5227 +))) 5228 +))) 5229 +))) 5230 +))) 5231 +))) 5232 + 5233 + 5234 +== **Редактирование года урожая ** == 5235 + 5236 +(% class="box successmessage" %) 5237 +((( 5238 +**POST /api/v3/agroLands/updateOpenCloseYear** 5239 +))) 5240 + 5241 +Пример запроса: 5242 + 5243 +((( 5244 +((( 5245 +{ 5246 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5247 + 0 5248 + ], 5249 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5250 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5251 +} 5252 +))) 5253 + 5254 + 5255 +))) 5256 + 5257 +Пример ответа: 5258 + 5259 +((( 5260 +((( 5261 +{ 5262 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5263 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5264 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5265 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5266 + "cropRotations": [ ~/~/ Данные по севообороту 5267 + { 5268 + "landId": 0, ~/~/ ID поля 5269 + "landName": "string", ~/~/ Название поля 5270 + "year": 0, ~/~/ Год урожая 5271 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5272 + "cultureName": "string", ~/~/ Название культуры 5273 + "productivity": 0, ~/~/ Урожайность 5274 + "area": 0, ~/~/ Площадь поля, Га. 5275 + "total": 0, ~/~/ Валовый сбор 5276 + "productivityFact": 0, ~/~/ Фактическая урожайность 5277 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5278 + "totalFact": 0, ~/~/ Фактический валовый сбор 5279 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5280 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5281 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5282 + "isyearplan": true, ~/~/ 5283 + "comment": "string" ~/~/ Комментарий 5284 + } 5285 + ], 5286 + "cropVegetation": [ ~/~/ История вегетации поля 5287 + { 5288 + "values": [ ~/~/ Данные вегетации и состояния посева 5289 + { 5290 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5291 + "ndvi": 0 ~/~/ Индекс вегетации 5292 + } 5293 + ], 5294 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5295 + { 5296 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5297 + "type": "string", ~/~/ Тип 5298 + "pictureid": "string" ~/~/ Идентификатор ресурса 5299 + } 5300 + ], 5301 + "states": [ ~/~/ Ключевые даты развития поля 5302 + { 5303 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5304 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5305 + } 5306 + ] 5307 + } 5308 + ], 5309 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5310 + "counts": { 5311 + "fieldOperations": 0, ~/~/ Количество операций на поле 5312 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5313 + "facts": 0 ~/~/ Счётчик факта 5314 + }, 5315 + "planComment": "string", ~/~/ Комментарий к полю 5316 + "productivity": 0, ~/~/ Урожайность. 5317 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5318 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5319 + "year": 0, ~/~/ Год поля 5320 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5321 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5322 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5323 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5324 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5325 + "id": 0, ~/~/ Идентификатор объекта геозоны 5326 + "name": "string", ~/~/ Название объекта геозоны 5327 + "type": 0, ~/~/ Тип объекта геозоны 5328 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5329 + "fname": "string", ~/~/ Имя файла 5330 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5331 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5332 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5333 + "description": "string", ~/~/ Описание объекта геозоны 5334 + "area": 0, ~/~/ Площадь, м2 5335 + "perimetr": 0, ~/~/ ериметр, м 5336 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5337 +} 5338 +))) 5339 + 5340 + 5341 +== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) == 5342 +))) 5343 +))) 5344 +))) 5345 + 5346 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5347 + 5348 + 5349 +(% class="box infomessage" %) 5350 +((( 5351 +**GET api/v3/Vehicles/recyclebin/all** 5352 +))) 5353 + 5354 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5355 + 5356 +Параметр запроса: {parentId} - идентификатор агента 5357 + 5358 +В заголовках запроса: X-Auth: Токен авторизации 5359 + 5360 +Ответ: 5361 + 5362 +[ 5363 + { 5364 + "recordTime": "", ~/~/Время записи 5365 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5366 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5367 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5368 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5369 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5370 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5371 + "items": [ ~/~/ 5372 +nullable: true ~/~/Детали 5373 + { 5374 + "name": "string", ~/~/наименование столбца 5375 + "value": "string" ~/~/содержание столбца 5376 + } 5377 + ] 5378 + }, 5379 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5380 + "string" 5381 + ] 5382 + } 5383 +] 5384 + 5385 + 5386 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5387 + 5388 +(% class="box infomessage" %) 5389 +((( 5390 +**POST api/v3/Vehicles/recyclebin/erase** 5391 +))) 5392 + 5393 +В заголовках запроса: X-Auth: Токен авторизации 5394 + 5395 +Пример запроса: 5396 + 5397 +[ 5398 +0 5399 +] 5400 + 5401 + 5402 +Пример ответа: 5403 + 5404 +[ 5405 +{ 5406 + "recordTime": "", ~/~/Время записи 5407 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5408 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5409 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5410 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5411 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5412 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5413 + "items": [ ~/~/Детали 5414 + { 5415 + "name": "", ~/~/Имя свойства 5416 + "value": "" ~/~/Значение свойства 5417 + } 5418 + ] 5419 + }, 5420 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5421 + "" 5422 + ] 5423 + } 5424 +] 5425 + 5426 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5427 + 5428 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5429 + 5430 +(% class="box infomessage" %) 5431 +((( 5432 +**POST api/v3/Vehicles/recyclebin/restore** 5433 +))) 5434 + 5435 +В заголовках запроса: X-Auth: Токен авторизации 5436 + 5437 +Параметры в теле запроса (JSON): 5438 + 5439 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5440 + 5441 +В заголовках запроса: X-Auth: Токен авторизации 5442 + 5443 + 5444 +Пример запроса: 5445 + 5446 +((( 5447 +[ 5448 +))) 5449 + 5450 +((( 5451 + 0 5452 +))) 5453 + 5454 +((( 5455 +] 5456 +))) 5457 + 5458 + 5459 +Пример ответа: 5460 + 5461 +[ 5462 +{ 5463 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5464 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5465 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5466 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5467 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5468 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5469 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5470 + "items": [ ~/~/Детали 5471 + { 5472 + "name": "string", ~/~/Имя свойства 5473 + "value": "string" ~/~/Значение свойства 5474 + } 5475 + ] 5476 + }, 5477 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5478 + "string" 5479 + ] 5480 + } 5481 +] 5482 + 5483 + 5484 + 3048 3048 (% class="box" lang="en-US" style="text-align: center;" %) 3049 3049 ((( 3050 3050 (% 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