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, ... ... @@ -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 клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 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 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 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 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -930,6 +930,17 @@ 930 930 931 931 ((( 932 932 { 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 + 933 933 "vehicleId": "", ~/~/ ID объекта 934 934 "name": "", ~/~/ Имя объекта 935 935 "imei": "", ~/~/ IMEI объекта ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,19 +1094,27 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1180 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", 1102 1102 "description": "string", 1103 1103 "additionalInfo": "string" 1104 - } 1105 - ] 1106 1106 1187 +((( 1107 1107 } 1189 + ], 1190 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1191 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1108 1108 ))) 1109 1109 1194 +((( 1195 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1196 +} 1197 + 1198 +))) 1199 +))) 1200 + 1110 1110 (% style="text-align:left" %) 1111 1111 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1112 1112 ... ... @@ -1113,6 +1113,75 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 1207 + 1208 +== **Отправить команду на терминал** == 1209 + 1210 +(% class="box successmessage" %) 1211 +((( 1212 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1213 +))) 1214 + 1215 +Команда для отправки на тс. 1216 + 1217 +{ 1218 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1219 +"command": "", ~/~/ Текст отправляемой команды 1220 +"retries": "", ~/~/ Количество попыток отправки на терминал 1221 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1222 +} 1223 + 1224 +В ответ получаем cmdid 1225 + 1226 + 1227 +== **Получить ответ на отправленную на ТС команду** == 1228 + 1229 +(% class="box infomessage" %) 1230 +((( 1231 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1232 +))) 1233 + 1234 +Идентификатор команды: cmdId 1235 + 1236 +Запрос от терминала на ответ команды 1237 + 1238 +Пример ответ от терминала: 1239 + 1240 +ID= "" ~/~/ идентификатор объекта 1241 +Soft="" ~/~/ версия софта 1242 +GPS=4 ~/~/ тип трекера 1243 +Time=11:05:43 28.06.24 ~/~/ время запроса 1244 +Lat=45.056221 ~/~/ широта 1245 +Lon=39.035938 ~/~/ долгота 1246 +Speed=0.0 ~/~/ скорость 1247 +Course=181.4 ~/~/направление 1248 + 1249 +((( 1250 +== **Список отправленных объекту команд с ответами** == 1251 + 1252 +(% class="box infomessage" %) 1253 +((( 1254 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1255 +))) 1256 + 1257 +Идентификатор ТС: vehicleId 1258 + 1259 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1260 + 1261 +Пример ответа терминала 1262 + 1263 +[ 1264 +{ 1265 +"id": "", ~/~/ идентификатор пользователя 1266 +"commandText": "", ~/~/Текст команды. 1267 +"templateId": "", ~/~/Идентификатор шаблона 1268 +"updated": "", ~/~/ Время отправки 1269 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1270 +"answer": "", ~/~/ Ответ терминала. 1271 +"status": "" ~/~/ Статус отправки 1272 +} 1273 +] 1274 +))) 1275 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1132,6 +1132,11 @@ 1132 1132 1133 1133 (% style="color:#000000" %){ 1134 1134 1295 + 1296 +((( 1297 + "vehicleId": 0, ~/~/ ID ТС 1298 +))) 1299 + 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1366 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1239,103 +1239,292 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1416 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1417 + 1418 +((( 1419 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1420 + { 1421 + "from": 0, ~/~/ С какого значения 1422 + "color": "string", ~/~/ Каким цветом 1423 + "text": "string" ~/~/ Текст подписи к этому интервалу 1424 + } 1425 + ] 1267 1267 } 1268 1268 ], 1428 +))) 1429 + 1430 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1431 + 1432 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1277 - } 1278 - ] 1435 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1436 + "name": "string", ~/~/ Наименование произвольного поля 1437 + "value": "string", ~/~/ Значение произвольного поля 1438 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1439 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1440 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1441 + 1442 +((( 1443 + } 1444 + ], 1445 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1446 +))) 1447 + 1448 +((( 1449 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1279 1279 } 1451 +))) 1280 1280 1453 + 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1457 +((( 1458 +((( 1459 +((( 1460 +{ 1461 + "vehicleId": 0, ~/~/ ID ТС 1462 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1463 + "name": "string", ~/~/ Имя объекта 1464 + "imei": "string", ~/~/ IMEI 1465 + "deviceTypeId": 0, ~/~/ ID типа устройства 1466 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1467 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1468 + "sim1": "string", ~/~/ SIM1 1469 + "sim2": "string", ~/~/ SIM2 1470 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1471 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1472 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1473 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1474 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1475 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1476 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1477 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1478 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1479 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1480 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1481 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1482 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1483 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1484 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1485 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1486 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1487 + "counters": { ~/~/ Dto для состояний счётчиков 1488 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1489 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1490 + "mileage": 0, ~/~/ Пробег 1491 + "motohours": 0 ~/~/ Моточасы 1492 + }, 1493 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1494 + "id": "string", ~/~/ CMSV6 Идентификатор 1495 + "enabled": true, ~/~/ Признак включения 1496 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1497 + "login": "string", ~/~/ CMSV6 имя учетной записи 1498 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1499 + }, 1500 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1501 + { 1502 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1503 + "enabled": true, ~/~/ Признак включения 1504 + "name": "string", ~/~/ Имя задания 1505 + "description": "string", ~/~/ Описание задания 1506 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1507 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1508 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1509 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1510 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1511 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1512 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1513 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 1515 + ], 1516 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1517 + { 1518 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1519 + "inputNumber": 0, ~/~/ № входа. 1520 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1521 + "comment": "string", ~/~/ Комментарий 1522 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1523 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1524 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1525 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1526 + } 1527 + ], 1528 + "commandTemplates": [ ~/~/ Список шаблонов команд 1529 + { 1530 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1531 + "name": "string", ~/~/ Название шаблона команд 1532 + "command": "string", ~/~/ Команда на выполнение 1533 + "retries": 0 ~/~/ Лимит попыток отправки 1534 + } 1535 + ], 1536 + "sensors": [ ~/~/ Список датчиков 1537 + { 1538 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1539 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1540 + "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 1541 + "name": "string", ~/~/ Имя датчика 1542 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1543 + "inputNumber": 0, ~/~/ Номер входа 1544 + "pseudonym": "string", ~/~/ Псевдоним 1545 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1546 + "isInverted": true, ~/~/ Признак инверсии 1547 + "disabled": true, ~/~/ Датчик не участвует в обработке 1548 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1549 + "gradesTables": [ ~/~/ Тарировка 1550 + { 1551 + "grades": [ ~/~/ Таблицы тарировки 1552 + { 1553 + "input": 0, ~/~/ Вход 1554 + "output": 0 ~/~/ Выход 1555 + } 1556 + ], 1557 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1558 + } 1559 + ], 1560 + "showInTooltip": true, ~/~/ Отображение в подсказке 1561 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1562 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1563 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1564 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1565 + "expr": "string", ~/~/ Выражение 1566 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1567 + "string" 1568 + ], 1569 + "customParams": { 1570 + "additionalProp1": "string", 1571 + "additionalProp2": "string", 1572 + "additionalProp3": "string" 1573 + }, 1574 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1575 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1576 + { 1577 + "from": 0, ~/~/ С какого значения 1578 + "color": "string", ~/~/ Каким цветом 1579 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% style="color:#000000" %)} 1581 +((( 1582 + "text": "string" ~/~/ Текст подписи к этому интервалу 1583 + } 1584 + ] 1585 + } 1586 + ], 1587 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1588 + "customFields": [ ~/~/ Список произвольных полей 1589 + { 1590 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1591 + "name": "string", ~/~/ Наименование произвольного поля 1592 + "value": "string", ~/~/ Значение произвольного поля 1593 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1594 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1595 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1596 + } 1597 + ], 1598 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1599 +} 1600 +))) 1601 +))) 1602 +))) 1325 1325 1604 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1332 1332 1611 +== **Импортировать историю ТС (Асинхронный запрос)** == 1612 + 1613 +(% class="box successmessage" %) 1614 +((( 1615 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 1616 +))) 1617 + 1618 +Метод запроса: **POST** 1619 + 1620 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 1621 + 1622 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 1623 + 1624 + 1625 +Ответ: 1626 + 1627 +{ 1628 + 1629 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1630 + 1631 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 1632 + 1633 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 1634 + 1635 + "Message": "string", ~/~/ Информация о выполнении запроса 1636 + 1637 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 1638 + 1639 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1640 + 1641 + "Data": "string" ~/~/ Данные 1642 + 1643 +} 1644 + 1645 + 1646 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 1647 + 1333 1333 (% class="box infomessage" %) 1334 1334 ((( 1650 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 1651 +))) 1652 + 1653 +Метод запроса: **GET** 1654 + 1655 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 1656 + 1657 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 1658 + 1659 + 1660 +Ответ: 1661 + 1662 +{ 1663 + 1664 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 1665 + 1666 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 1667 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 1668 + 1669 + "Message": "string", ~/~/ Информация о выполнении запроса 1670 + 1671 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 1672 + 1673 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 1674 + 1675 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 1676 + 1677 + "Data": "string" ~/~/ Данные 1678 + 1679 +} 1680 + 1681 + 1682 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1683 + 1684 +(% class="box infomessage" %) 1685 +((( 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1689 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1369,9 +1369,12 @@ 1369 1369 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1370 1370 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1371 1371 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1372 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1373 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1374 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1723 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1724 + "unitName": "string", ~/~/ Название подразделения (опционально) 1725 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1726 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1727 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1728 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1375 1375 } 1376 1376 1377 1377 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1378,8 +1378,14 @@ 1378 1378 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 -(% style="color:#000000" %){ 1735 +(% style="color:#000000" %)[ 1736 +{ 1382 1382 1738 +((( 1739 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1740 +))) 1741 + 1742 +((( 1383 1383 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта ... ... @@ -1405,9 +1405,21 @@ 1405 1405 "forClient": true, ~/~/ право на отображение у клиента 1406 1406 "forTooltip": false, ~/~/ право на отображение в подсказке 1407 1407 "forReport": false ~/~/ право на отображение в отчетах 1408 - }(%%) 1409 -(% style="color:#000000" %)} 1768 +))) 1410 1410 1770 +((( 1771 + } 1772 + ], 1773 + "vehicleGroups": [ ~/~/ Группы ТС 1774 + { 1775 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1776 + "name": "string" ~/~/ Наименование группы ТС 1777 + } 1778 + ] 1779 + } 1780 +] 1781 +))) 1782 + 1411 1411 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1412 1412 1413 1413 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1818 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,10 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1827 +== == 1828 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1531,9 +1531,19 @@ 1531 1531 1532 1532 "drivers": [ ~/~/ Водители 1533 1533 { 1534 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 - "isDefault": true 1536 - } 1904 + 1905 +((( 1906 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1907 + "inputNumber": 0, ~/~/ № входа. 1908 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1909 + "comment": "string", ~/~/ Комментарий. 1910 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1911 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1912 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1913 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1914 +))) 1915 + 1916 + } 1537 1537 ], 1538 1538 "commandTemplates": [ ~/~/ Шаблон команды 1539 1539 { ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1926 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1570,6 +1570,11 @@ 1570 1570 ], 1571 1571 "showInTooltip": true, ~/~/ Отображать в подсказке 1572 1572 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1952 + 1953 +((( 1954 + "color": "string",** ~/~/ **Цвет датчика 1955 +))) 1956 + 1573 1573 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 1574 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 1575 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1582,95 +1582,225 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1982 + 1983 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1984 + { 1985 + "from": 0, ~/~/ С какого значения 1986 + "color": "string", ~/~/ Каким цветом 1987 + "text": "string" ~/~/ Текст подписи к этому интервалу 1988 + } 1989 + ] 1610 1610 } 1611 1611 ], 1992 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1993 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 1995 + { 1996 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1997 + "name": "string", ~/~/ Наименование произвольного поля 1998 + "value": "string", ~/~/ Значение произвольного поля 1999 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2000 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2001 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 - ] 2003 + 2004 +((( 2005 + ], 2006 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 2007 +))) 2008 + 1622 1622 } 1623 1623 2011 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 2014 +((( 2015 +{ 2016 + "vehicleId": 0, ~/~/ ID ТС 2017 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 2018 + "name": "string", ~/~/ Имя объекта 2019 + "imei": "string", ~/~/ IMEI 2020 + "deviceTypeId": 0, ~/~/ ID типа устройства 2021 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 2022 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 2023 + "sim1": "string", ~/~/ SIM1 2024 + "sim2": "string", ~/~/ SIM2 2025 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 2026 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 2027 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 2028 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 2029 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 2030 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 2031 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 2032 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 2033 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 2034 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 2035 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 2036 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 2037 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 2038 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 2039 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 2040 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 2041 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 2042 + "counters": { ~/~/ состояний счётчиков 2043 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 2044 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 2045 + "mileage": 0, ~/~/ Пробег 2046 + "motohours": 0 ~/~/ Моточасы 2047 + }, 2048 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 2049 + "id": "string", ~/~/ CMSV6 Идентификатор 2050 + "enabled": true, ~/~/ Признак включения 2051 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2052 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 2054 + 2055 +((( 2056 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2057 + "login": "string", ~/~/ CMSV6 имя учетной записи 2058 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2059 + }, 2060 + "inspectionTasks": [ ~/~/ Задания на ТО 2061 + { 2062 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2063 + "enabled": true, ~/~/ Признак включения 2064 + "name": "string", ~/~/ Имя задания 2065 + "description": "string", ~/~/ Описание задания 2066 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2067 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2068 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2069 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2070 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2071 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2072 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2073 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2074 + } 2075 + ], 2076 + "drivers": [ ~/~/ Список водителей 2077 + { 2078 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2079 + "inputNumber": 0, ~/~/ № входа. 2080 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2081 + "comment": "string", ~/~/ Комментарий. 2082 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2083 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2084 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2085 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2086 + } 2087 + ], 2088 + "commandTemplates": [ ~/~/ Список шаблонов команд 2089 + { 2090 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2091 + "name": "string", ~/~/ Название шаблона команд 2092 + "command": "string", ~/~/ Команда на выполнение 2093 + "retries": 0 ~/~/ Лимит попыток отправки 2094 + } 2095 + ], 2096 + "sensors": [ ~/~/ Список датчиков 2097 + { 2098 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2099 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2100 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2101 +))) 2102 + 2103 +((( 2104 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2105 +))) 2106 + 2107 +((( 2108 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2109 +))) 2110 + 2111 +((( 2112 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2113 +))) 2114 + 2115 +((( 2116 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2117 +))) 2118 + 2119 +((( 2120 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2121 + "name": "string", ~/~/ Имя датчика 2122 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2123 +))) 2124 + 2125 +((( 2126 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2127 + "inputNumber": 0, ~/~/ Номер входа 2128 + "pseudonym": "string", ~/~/ Псевдоним 2129 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2130 + "isInverted": true, ~/~/ Признак инверсии 2131 + "disabled": true, ~/~/ Датчик не участвует в обработке 2132 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2133 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1657 - { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2135 + "grades": [ ~/~/ Таблицы тарировки 2136 + { 2137 + "input": 0, ~/~/ Вход 2138 + "output": 0 ~/~/ Выход 2139 + } 2140 + ], 2141 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1669 1669 } 2143 + ], 2144 + "showInTooltip": true, ~/~/ Отображение в подсказке 2145 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2147 +((( 2148 + "color": "string", ~/~/ цвет уведомлений 2149 +))) 1673 1673 2151 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2152 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2153 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2154 + "expr": "string", ~/~/ Выражение 2155 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2156 + "string" 2157 + ], 2158 + "customParams": { ~/~/ Дополнительные настройки 2159 + "additionalProp1": "string", 2160 + "additionalProp2": "string", 2161 + "additionalProp3": "string" 2162 + }, 2163 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2164 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2165 + { 2166 + "from": 0, ~/~/ С какого значения 2167 + "color": "string", ~/~/ Каким цветом 2168 + "text": "string" ~/~/ Текст подписи к этому интервалу 2169 + } 2170 + ] 2171 + } 2172 + ], 2173 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2174 + "customFields": [ ~/~/ Список произвольных полей 2175 + { 2176 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2177 + "name": "string", ~/~/ Наименование произвольного поля 2178 + "value": "string", ~/~/ Значение произвольного поля 2179 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2180 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2181 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2182 + } 2183 + ], 2184 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2185 +} 2186 +))) 2187 + 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2226 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2232 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2256 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2303 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2304 + 2305 +(% class="box infomessage" style="text-align: left;" %) 2306 +((( 2307 +**POST /api/v3/terminalMessages/mapping** 2308 +))) 2309 + 2310 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2311 + 2312 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2313 + 2314 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2315 + 2316 +{ 2317 + "protocolType": 0, 2318 + "params": ["string"] 2319 +} 2320 + 2321 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2322 +|protocolType|ID типа протокола 2323 +|params|((( 2324 +Массив наименований параметров в сообщении 2325 +))) 2326 + 2327 +Ответ: 2328 + 2329 +{ 2330 + "protocolType": 0, 2331 + "mapping": { 2332 + "additionalProp1": { 2333 + "inputType": 0, 2334 + "inputNumber": 0 2335 + }, 2336 + "additionalProp2": { 2337 + "inputType": 0, 2338 + "inputNumber": 0 2339 + } 2340 + } 2341 +} 2342 + 2343 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2344 +|protocolType|Тип протокола 2345 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2346 +|inputNumber|((( 2347 +Номер входа 2348 +))) 2349 + 2350 +(% class="wikigeneratedid" %) 2351 +Перечень 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/]] 2352 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2377 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2378 +|vehicleId|ID объекта 2379 +|from|Дата и время начала периода запроса 2380 +|to|Дата и время окончания периода запроса 2381 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2388 + "deviceTime": "2023-11-29T07:40:44.052Z", 2389 + "serverTime": "2023-11-29T07:40:44.052Z", 2390 + "speed": 0, 2391 + "altitude": 0, 2392 + "latitude": 0, 2393 + "longitude": 0, 2394 + "satellites": 0, 2395 + "course": 0, 2396 + "voltage": 0, 2397 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2402 + "photoCount": 0, 2403 + "lbsCorrectedCoords": true, 2404 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2410 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2411 +|deviceTime|Время сообщения терминала 2412 +|serverTime|Время когда сообщение поступило на сервер 2413 +|speed|Скорость 2414 +|altitude|Высота над уровнем моря 2415 +|latitude|Широта 2416 +|longitude|Долгота 2417 +|satellites|Кол-во спутников 2418 +|course|Курс 2419 +|voltage|Бортовое напряжение 2420 +|parameters|Список параметров и их значений 2421 +|photoCount|Количество фото 2422 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2423 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1932,10 +1932,12 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2461 + "mileage": 0, ~/~/ Пробег за период, километры 2462 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2463 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2464 + "motohours": 0, ~/~/ Моточасы за период, секунды 2465 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2466 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1984,6 +1984,12 @@ 1984 1984 } 1985 1985 ] 1986 1986 2515 +(% class="box warningmessage" %) 2516 +((( 2517 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2518 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2519 +))) 2520 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2566 + 2567 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2568 + 2569 +(% class="box infomessage" %) 2570 +((( 2571 +**POST /api/v3/vehicles/moveStop** 2572 +))) 2573 + 2574 +Метод запроса: **POST** 2575 + 2576 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2577 + 2578 +В заголовках запроса: X-Auth: Токен авторизации 2579 + 2580 + 2581 +Тело запроса: 2582 + 2583 +{ 2584 + "vehicleIds": [ ], ~/~/ Список ID объектов 2585 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2586 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2587 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2588 +} 2589 + 2590 +Ответ: 2591 + 2592 +[ 2593 + { 2594 + "vehicleId": 0, ~/~/ ID объекта 2595 + "vehicleName": "string", ~/~/ Имя объекта 2596 + "moves": [ ~/~/ Событие движения 2597 + { 2598 + "mileage": 0, ~/~/ Пробег, км 2599 + "eventId": 0, ~/~/ Идентификатор события 2600 + "eventName": "string", ~/~/ Название события 2601 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2602 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2603 + "duration": 0 ~/~/ Продолжительность события, секунд 2604 + } 2605 + ], 2606 + "stops": [ ~/~/ События стоянок 2607 + { 2608 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2609 + "eventId": 0, ~/~/ Идентификатор события 2610 + "eventName": "string", ~/~/ Название события 2611 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2612 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2613 + "duration": 0 ~/~/ Продолжительность события, секунд 2614 + } 2615 + ] 2616 + } 2617 +] 2618 + 2619 + 2620 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2621 + 2622 +(% class="box infomessage" %) 2623 +((( 2624 +**POST /api/v3/vehicles/getlastdata** 2625 +))) 2626 + 2627 +Метод запроса: **POST** 2628 + 2629 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2630 + 2631 +В заголовках запроса: X-Auth: Токен авторизации 2632 + 2633 + 2634 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2635 + 2636 +Ответ: 2637 + { 2638 + "vehicleId": 0, ~/~/Идентификатор объекта. 2639 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2640 + "vehicleNumber": "string",~/~/Номер объекта. 2641 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2642 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2643 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2644 + "speed": 0,~/~/Скорость объекта. 2645 + "course": 0,~/~/Курс движения [0;360] 2646 + "latitude": 0,~/~/Широта [-90°;90°]. 2647 + "longitude": 0,~/~/Долгота [-180°;180°]. 2648 + "address": "string",~/~/Адрес. 2649 + "geozones": [ ~/~/Сведения по геозонам. 2650 + { 2651 + "id": 0, 2652 + "name": "string" 2653 + } 2654 + 2655 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 2963 + 2964 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2965 + 2966 +(% class="box warningmessage" %) 2967 +((( 2968 +**PUT** /api/v3/notifications/prolongation 2969 +))) 2970 + 2971 +Метод позволяет продлить уведомления. 2972 + 2973 +Метод запроса **PUT** 2974 + 2975 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2976 + 2977 +В заголовках запроса: X-Auth: Токен авторизации. 2978 + 2979 +Тело запроса: 2980 + 2981 +[ 2982 + 2983 +0 2984 + 2985 +] 2986 + 2987 +где 0 идентификатор ids. 2988 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3580 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3581 + 3582 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3583 + 3584 +(% class="box infomessage" %) 3585 +((( 3586 +**POST /api/v3/Trailers** 3587 +))) 3588 + 3589 +Пример запроса: 3590 + 3591 +{ 3592 + "startDate": "2023-11-14T10:48:03.671Z", 3593 + "endDate": "2023-11-14T10:48:03.671Z", 3594 + "ids": [ 0 ], 3595 + "timezone": 0 3596 +} 3597 + 3598 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3599 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3600 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3601 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3602 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3603 + 3604 +Пример ответа: 3605 + 3606 +[ 3607 + { 3608 + "SD": "2023-11-14T10:48:03.717Z", 3609 + "ED": "2023-11-14T10:48:03.717Z", 3610 + "id": 0, 3611 + "SLat": 0, 3612 + "SLon": 0, 3613 + "ELat": 0, 3614 + "ELon": 0, 3615 + "mileage": 0 3616 + "Duration": 0 3617 + "Address": "string", 3618 + "Address2": "string", 3619 + "name": "string", 3620 + "rid": "string", 3621 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3622 + "trailer": { 3623 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3624 + "Number": "string", 3625 + "Description": "string", 3626 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3627 + "ExternalID": "string", 3628 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3629 + "CreateTime": "2023-11-14T10:48:03.717Z", 3630 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3631 + "IsDeleted": true 3632 + }, 3633 + "filesCount": 0, 3634 + } 3635 +] 3636 + 3637 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3638 +|SD|Дата и время начала события 3639 +|ED|Дата и время окончания события 3640 +|id|ID объекта 3641 +|SLat|Широта начальной координаты 3642 +|SLon|Долгота начальной координаты 3643 +|ELat|Широта конечной координаты 3644 +|ELon|Долгота конечной координаты 3645 +|mileage|Пробег 3646 +|Duration|Продолжительность 3647 +|Address|Адрес начального местоположения 3648 +|Address2|Адрес конечного местоположения 3649 +|name|Имя радиометки 3650 +|rid|Номер радиометки 3651 +|rguid|ID радиометки 3652 +|trailer|Информация об агрегате 3653 +|ModelGuid|ID агрегата 3654 +|Number|Название/номер агрегата 3655 +|Description|Текст примечания агрегата 3656 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3678 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3684 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3685 +|parentId|ID клиента 3686 +|name|Название карты-метки 3687 +|number|Номер 3688 +|period|Период запросов в секундах (работает только для агрегатов) 3689 +|id|ID карты-метки 3690 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3706 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3712 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3713 +|name|Название карты-метки 3714 +|number|Номер 3715 +|period|Период запросов в секундах (работает только для агрегатов) 3716 +|id|ID карты-метки 3717 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3745 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3746 +|name|Название карты-метки 3747 +|number|Номер 3748 +|period|Период запросов в секундах (работает только для агрегатов) 3749 +|id|ID карты-метки 3750 +|parentId|ID клиента 3751 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3779 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3780 +|name|Название карты-метки 3781 +|number|Номер 3782 +|period|Период запросов в секундах (работает только для агрегатов) 3783 +|id|ID карты-метки 3784 +|parentId|ID клиента 3785 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3793 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3051,7 +3051,6 @@ 3051 3051 3052 3052 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 3053 3054 -(% class="wikigeneratedid" %) 3055 3055 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3056 3056 3057 3057 (% class="box infomessage" %) ... ... @@ -3072,7 +3072,6 @@ 3072 3072 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3073 3073 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3074 3074 3075 -(% class="wikigeneratedid" %) 3076 3076 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3077 3077 3078 3078 (% class="box infomessage" %) ... ... @@ -3103,7 +3103,6 @@ 3103 3103 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3104 3104 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3105 3105 3106 -(% class="wikigeneratedid" %) 3107 3107 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3108 3108 3109 3109 (% class="box infomessage" %) ... ... @@ -3177,7 +3177,6 @@ 3177 3177 |PeriodValue|Значение периода. 3178 3178 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3179 3179 3180 -(% class="wikigeneratedid" %) 3181 3181 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3182 3182 3183 3183 (% class="box infomessage" %) ... ... @@ -3229,7 +3229,6 @@ 3229 3229 |PeriodValue|Значение периода. 3230 3230 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3231 3231 3232 -(% class="wikigeneratedid" %) 3233 3233 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3234 3234 3235 3235 (% class="box infomessage" %) ... ... @@ -3281,6 +3281,72 @@ 3281 3281 |PeriodValue|Значение периода. 3282 3282 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3283 3283 4027 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4028 + 4029 +(% class="box warningmessage" %) 4030 +((( 4031 +**PUT /api/v3/Billing/client/balance** 4032 +))) 4033 + 4034 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4035 + 4036 +Тело запроса: 4037 + 4038 +{ 4039 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4040 + "Balance": 0 4041 +} 4042 + 4043 +Ответ: Success 4044 + 4045 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4046 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4047 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4048 + 4049 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4050 + 4051 +(% class="box warningmessage" %) 4052 +((( 4053 +**PUT /api/v3/billing/client/balance/deposit** 4054 +))) 4055 + 4056 +Создает операцию **Пополнение **с указанной суммой 4057 + 4058 +Тело запроса: 4059 + 4060 +{ 4061 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4062 + "Balance": 0 4063 +} 4064 + 4065 +Ответ: Success 4066 + 4067 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4068 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4069 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4070 + 4071 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4072 + 4073 +Создает операцию **Списание **с указанной суммой 4074 + 4075 +(% class="box warningmessage" %) 4076 +((( 4077 +**PUT /api/v3/billing/client/balance/withdraw** 4078 +))) 4079 + 4080 +Тело запроса: 4081 + 4082 +{ 4083 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4084 + "Balance": 0 4085 +} 4086 + 4087 +Ответ: Success 4088 + 4089 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4090 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4091 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4092 + 3284 3284 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3285 3285 3286 3286 (% class="box warningmessage" %) ... ... @@ -3343,6 +3343,7 @@ 3343 3343 3344 3344 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3345 3345 |ClientId|Идентификатор клиента 4155 +|PlanId|Идентификатор тарифного плана 3346 3346 |Feature|Код услуги 3347 3347 |IsEnabled|Признак, определяющий активирована ли услуга 3348 3348 |IsFactual|Признак, определяющий расчёт по факту ... ... @@ -3352,7 +3352,1298 @@ 3352 3352 |PeriodValue|Значение периода. 3353 3353 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3354 3354 4165 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3355 3355 4167 +(% class="box warningmessage" %) 4168 +((( 4169 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4170 +))) 4171 + 4172 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4173 + 4174 +(% class="box infomessage" %) 4175 +((( 4176 +**POST /api/v3/vehicles/import/{agentId}** 4177 +))) 4178 + 4179 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4180 + 4181 +В пути указывается **agentId** - id клиента. 4182 + 4183 +**Заголовок** 4184 + 4185 +**X-Auth: [токен авторизации]** 4186 + 4187 +**Параметры** 4188 + 4189 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4190 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4191 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4192 + 4193 +В теле использовать тип **form-data,** тип значения** file** 4194 + 4195 +**Ключи** 4196 + 4197 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4198 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4199 +|csv|В значении передаем файл датчиков, формат **csv** 4200 + 4201 +Ответ: 4202 + 4203 +{ 4204 + "vehicleId": 0, 4205 + "name": "string", 4206 + "errors": ["string"] 4207 +} 4208 + 4209 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4210 +|vehicleId|ID созданного объекта 4211 +|name|Имя созданного объекта 4212 +|errors|Ошибки и их описание 4213 + 4214 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4215 + 4216 +(% class="box infomessage" %) 4217 +((( 4218 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4219 +))) 4220 + 4221 +(% class="wikigeneratedid" %) 4222 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4223 + 4224 +(% class="wikigeneratedid" %) 4225 +В пути указывается **vehicleId **- id объекта. 4226 + 4227 +**Заголовок** 4228 + 4229 +**X-Auth: [токен авторизации]** 4230 + 4231 +В теле использовать тип **form-data.** 4232 + 4233 +Ключи: 4234 + 4235 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4236 +|**history**|В значении передавать файл с историей 4237 + 4238 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4239 + 4240 +Ответ: 4241 + 4242 +{ 4243 + "results": [ 4244 + { 4245 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4246 + "vehicleId": 0, 4247 + "errors": [ 4248 + "string" 4249 + ], 4250 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4251 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4252 + "producedCount": 0, 4253 + "msgCount": 0 4254 + } 4255 + ] 4256 +} 4257 + 4258 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4259 +|results|Результаты импорта в разрезе ТС 4260 +|vehicleGuid|Guid ТС 4261 +|vehicleId|ID ТС 4262 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4263 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4264 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4265 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4266 +|msgCount|Кол-во обработанных сообщений всего 4267 + 4268 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4269 + 4270 +(% class="box infomessage" %) 4271 +((( 4272 +**GET /api/v3/vehicles/import/history/status** 4273 +))) 4274 + 4275 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4276 + 4277 +Ответ: 4278 + 4279 +{ 4280 + "activity": true, 4281 + "progress": 0, 4282 + "message": "string" 4283 +} 4284 + 4285 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4286 +|activity|Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4287 +|progress|Guid ТС 4288 + 4289 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4290 + 4291 +(% class="box infomessage" %) 4292 +((( 4293 +**POST /api/v3/vehicles/export** 4294 +))) 4295 + 4296 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4297 + 4298 +Тело запроса: 4299 + 4300 +[ 4301 + id 4302 +] 4303 + 4304 +Ответ: Success 200, получаете файлы с настройками. 4305 + 4306 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4307 + 4308 +(% class="box infomessage" %) 4309 +((( 4310 +**POST /api/v3/vehicles/export/history** 4311 +))) 4312 + 4313 +Метод возвращает список сообщений терминала объекта за выбранный период. 4314 + 4315 +Тело запроса: 4316 + 4317 +{ 4318 + "vehicleId": 0, 4319 + "asArchive": true, 4320 + "from": "2023-09-27T12:17:45.973Z", 4321 + "to": "2023-09-27T12:17:45.973Z" 4322 +} 4323 + 4324 +Ответ: 4325 + 4326 +Получаете файл. Сообщение: Code 200/Success 4327 + 4328 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4329 +|vehicleId|ID объекта 4330 +|asArchive|true - Архивировать файл, False - не архивировать 4331 +|from|Дата и время начала запроса 4332 +|to|Дата и время окончания запроса 4333 + 4334 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4335 + 4336 +(% class="box infomessage" %) 4337 +((( 4338 +**GET /api/v3/vehicles/export/history/status** 4339 +))) 4340 + 4341 +Метод возвращает список сообщений терминала объекта за выбранный период. 4342 + 4343 +Ответ: 4344 + 4345 +{ 4346 + "activity": true, 4347 + "progress": 0, 4348 + "message": "string" 4349 +} 4350 + 4351 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4352 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4353 +|progress|Прогресс экспорта, от 0 до 100% 4354 +|message|Текст описывающий статус 4355 + 4356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4357 + 4358 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4359 + 4360 +(% class="box infomessage" %) 4361 +((( 4362 +**POST /api/v3/EcoDriving/rating** 4363 +))) 4364 + 4365 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4366 + 4367 +Тело запроса: 4368 + 4369 +{ 4370 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4371 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4372 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4373 +} 4374 + 4375 +Ответ: 4376 + 4377 +{ 4378 + "items": [ ~/~/ Список в разрезе ТС 4379 + { 4380 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4381 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4382 + "vehicleId": 0, ~/~/ ID ТС 4383 + "vehicleName": "string", ~/~/ Название ТС 4384 + "vehicleModel": "string", ~/~/ Модель ТС 4385 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4386 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4387 + "totalViolations": 0, ~/~/ Нарушений всего 4388 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4389 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4390 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4391 + "brakingViolations": 0, ~/~/ Нарушений торможения 4392 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4393 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4394 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4395 + }, 4396 + 4397 +((( 4398 + 4399 +))) 4400 + 4401 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4402 + "mileage": 0, ~/~/ Пробег, м 4403 + "tripsCount": 0, ~/~/ Кол-во рейсов 4404 + "trips": [ ~/~/ Информация по рейсу 4405 + { 4406 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4407 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4408 + "violationsCount": 0, ~/~/ Всего нарушений 4409 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4410 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4411 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4412 + "brakingViolations": 0, ~/~/ Нарушений торможения 4413 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4414 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4415 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4416 + }, 4417 + 4418 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4419 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4420 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4421 + "mileage": 0, ~/~/ Пробег, м 4422 + "motohours": 0, ~/~/ Моточасы, секунды 4423 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4424 + "startAddress": "string", ~/~/ Адрес начала рейса 4425 + "endAddress": "string", ~/~/ Адрес конца рейса 4426 + "drivers": [ ~/~/ Список водителей 4427 + { 4428 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4429 + "driverName": "string", ~/~/ФИО водителя 4430 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4431 + } 4432 + ] 4433 + } 4434 + ] 4435 + } 4436 + ] 4437 +} 4438 + 4439 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4440 + 4441 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4442 + 4443 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4444 + 4445 +(% class="box infomessage" %) 4446 +((( 4447 +POST /api/v3/fuelcards/transactions 4448 +))) 4449 + 4450 +Метод запроса: POST 4451 + 4452 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4453 +\\В заголовках запроса: X-Auth: Токен авторизации 4454 + 4455 +Параметры в теле запроса (JSON): 4456 + 4457 +{ 4458 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4459 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4460 + "ids": [ 4461 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4462 + ], 4463 + "timezone": 0 ~/~/ Часовой пояс 4464 +} 4465 + 4466 + 4467 +Ответ: 4468 + { 4469 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4470 + "driver": "string", ~/~/ Водители, привязанные к ТК 4471 + "object": "string", ~/~/ Наименование ТС 4472 + "amount": 0, ~/~/ Количество топлива 4473 + "amountDut": 0, ~/~/ Количество по ДУТ 4474 + "amountDiff": 0, ~/~/ Разница, л 4475 + "amountDiffPerc": 0, ~/~/ Разница, % 4476 + "summa": 0, ~/~/ Стоимость, руб 4477 + "serviceName": "string", ~/~/ Тип топлива 4478 + "price": 0, ~/~/ Цена за литр, руб 4479 + "cardName": "string", ~/~/ Наименование ТК 4480 + "cardNum": "string", ~/~/ Номер ТК 4481 + "operator": "string", ~/~/ Оператор ТК 4482 + "address": "string" ~/~/ Адрес АЗС 4483 + } 4484 + 4485 + 4486 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4487 + 4488 + 4489 +== **Получение полных данных о ретрансляторе** == 4490 + 4491 +(% class="box infomessage" %) 4492 +((( 4493 +**GET ** **/api/v3/retranslations/{id}** 4494 +))) 4495 + 4496 +id - Идентификатор ретранслятора 4497 + 4498 + 4499 +Пример ответа: 4500 + 4501 +{ 4502 +"description": "", ~/~/ Поле описания ретранслятора 4503 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4504 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4505 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4506 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4507 +"objects": [ ~/~/ Объекты для ретрансляции 4508 +{ 4509 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4510 +"name": "", ~/~/ Наименование объекта ретрансляции 4511 +"imei": "", ~/~/ IMEI объекта ретрансляции 4512 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4513 +} 4514 + ], 4515 +"id": "", ~/~/ Идентификатор ретранслятора 4516 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4517 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4518 +} 4519 + 4520 + 4521 +== **Удаление данных ретранслятора** == 4522 + 4523 +(% class="box infomessage" %) 4524 +((( 4525 +**DELETE** **/api/v3/retranslations/{id}** 4526 +))) 4527 + 4528 +id - Идентификатор ретранслятора 4529 + 4530 + 4531 +== **Создание ретранслятора** == 4532 + 4533 +(% class="box infomessage" %) 4534 +((( 4535 +**POST ** **/api/v3/retranslations/{id}** 4536 +))) 4537 + 4538 +Запрос: 4539 + 4540 +{ 4541 +"description": "", ~/~/ Поле описания ретранслятора 4542 +"subscriberId": "", ~/~/ Идентификатор подписчика 4543 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4544 +"address": "", ~/~/ Адрес и порт принимающего сервера 4545 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4546 +"objects": [ ~/~/Объекты для ретрансляции 4547 +{ 4548 +"id": "", ~/~/ Идентификатор ретранслятора 4549 +"imei": "", ~/~/ IMEI объекта ретрансляции 4550 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4551 +} 4552 + ] 4553 +} 4554 + 4555 + 4556 +Ответ: 4557 + 4558 +{ 4559 +"description": "", ~/~/ Поле описания ретранслятора 4560 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4561 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4562 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4563 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4564 +"objects": [ ~/~/ Объекты для ретрансляции 4565 +{ 4566 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4567 +"name": "string", ~/~/ Наименование объекта ретрансляции 4568 +"imei": "", ~/~/ IMEI объекта ретрансляции 4569 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4570 +} 4571 + ], 4572 +"id": "", ~/~/ Идентификатор ретранслятора 4573 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4574 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4575 +} 4576 + 4577 + 4578 +== **Редактирование ретранслятора** == 4579 + 4580 +(% class="box infomessage" %) 4581 +((( 4582 +**PUT** **/api/v3/retranslations** 4583 +))) 4584 + 4585 +Пример запроса: 4586 + 4587 +{ 4588 +"id": "", ~/~/ Идентификатор ретранслятора 4589 +"description": "string", ~/~/ Поле описания ретранслятора 4590 +"subscriberId": "", ~/~/ Идентификатор подписчика 4591 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4592 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4593 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4594 +"objects": ~/~/ Объекты для ретрансляции 4595 +[ 4596 +{ 4597 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4598 +"imei": "", ~/~/ IMEI объекта ретрансляции 4599 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4600 +} 4601 + ] 4602 +} 4603 + 4604 + 4605 +Пример ответа: 4606 + 4607 +{ 4608 +"description": "", ~/~/ Поле описания ретранслятора 4609 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4610 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4611 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4612 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4613 +"objects": [ ~/~/ Объекты для ретрансляции 4614 +{ 4615 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4616 +"name": "string", ~/~/ Наименование объекта ретрансляции 4617 +"imei": "", ~/~/ IMEI объекта ретрансляции 4618 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4619 +} 4620 + ], 4621 +"id": "", ~/~/ Идентификатор ретранслятора 4622 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4623 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4624 +} 4625 + 4626 + 4627 +== **Получение списка ретранслятора клиента** == 4628 + 4629 +(% class="box infomessage" %) 4630 +((( 4631 +**POST /api/v3/retranslations/find** 4632 +))) 4633 + 4634 +Пример запроса: 4635 + 4636 +{ 4637 +"id": "", ~/~/ Идентификатор ретранслятора 4638 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4639 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4640 +} 4641 + 4642 +Ответ: 4643 + 4644 +[ 4645 +{ 4646 +"description": "", ~/~/ Поле описания ретранслятора 4647 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4648 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4649 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4650 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4651 +"id": "", ~/~/ Идентификатор ретранслятора 4652 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4653 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4654 +} 4655 +] 4656 + 4657 + 4658 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4659 + 4660 +== **API для отчета по выгрузке комбайнов** == 4661 + 4662 +(% class="box infomessage" %) 4663 +((( 4664 +**POST /api/v3/Reports/harvesterUnloading** 4665 +))) 4666 + 4667 +Пример запроса: 4668 + 4669 +{ 4670 + "byTime": 0, ~/~/ Объединение событий по времени 4671 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4672 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4673 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4674 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4675 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4676 + 0 4677 + ], 4678 + "from": "", ~/~/ Дата и время начало запроса 4679 + "to": "", ~/~/ Дата и время окончания запроса 4680 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4681 +} 4682 + 4683 +Пример ответа: 4684 + 4685 +[ 4686 + { 4687 + "harvesterName": "", ~/~/Комбайн, номер 4688 + "harvesterId": 0, ~/~/Комбайн, id 4689 +"harvesterModel": "", ~/~/ Модель комбайна 4690 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4691 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4692 + "events": [ ~/~/Список событий в разрезе комбайна 4693 + { 4694 + "driverId": "", ~/~/Идентификатор водителя 4695 + "driverName": "", ~/~/Водитель комбайна, ФИО 4696 + "RFID": "", ~/~/ идентификатор карты-метки 4697 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4698 + "vehicleId": 0, ~/~/идентификатор объекта 4699 + "vehicleName": "string", ~/~/ Имя объекта 4700 + "modelName": "string", ~/~/ Имя модели объекта 4701 + "nearestVehicles": [ ~/~/Объекты рядом 4702 + { 4703 + "vehicleId": 0, ~/~/идентификатор объекта 4704 + "vehicleName": "string" ~/~/ Имя объекта 4705 + } 4706 + ], 4707 + "fields": [ ~/~/Поля, где происходила выгрузка 4708 + { 4709 + "id": 0, ~/~/ идентификатор пользователя 4710 + "name": "string" ~/~/ имя пользователя 4711 + } 4712 + ], 4713 + "event": "string", ~/~/Событие 4714 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4715 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4716 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4717 + "cultureName": "string", ~/~/ название культуры 4718 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4719 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4720 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4721 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4722 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4723 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4724 + "issued": 0, ~/~/Выдано, бункеров 4725 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4726 + "latitude": 0, ~/~/Широта 4727 + "longitude": 0, ~/~/ Долгота 4728 + "litresAway": 0, ~/~/Отдано, л 4729 + "m3Away": 0 ~/~/Отдано, м3 4730 + } 4731 + ] 4732 + } 4733 +] 4734 + 4735 + 4736 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4737 + 4738 + 4739 +== **Запрос списка полей** == 4740 + 4741 +(% class="box successmessage" %) 4742 +((( 4743 +**POST /api/v3/agroLands/find** 4744 +))) 4745 + 4746 +Пример запроса: 4747 + 4748 +((( 4749 +((( 4750 +((( 4751 +{ 4752 + "year": 0, ~/~/ Фильтр по году 4753 + "name": "string", ~/~/ Фильтр по названию 4754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4755 +} 4756 +))) 4757 +))) 4758 + 4759 + 4760 +))) 4761 + 4762 +Пример ответа: 4763 + 4764 +((( 4765 +[ 4766 + { 4767 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4768 + "year": 0, ~/~/ Год поля 4769 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4770 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4771 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4772 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4773 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4774 + "counts": { ~/~/ Счётчики с/х поля 4775 + "fieldOperations": 0, ~/~/ Количество операций на поле 4776 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4777 + "facts": 0 ~/~/ Счётчик факта 4778 + }, 4779 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4780 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4781 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4782 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4783 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4784 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4785 + "planComment": "string", ~/~/ Комментарий к полю 4786 + "productivity": 0, ~/~/ Урожайность. 4787 + "id": 0, ~/~/ Идентификатор объекта геозоны 4788 + "name": "string", ~/~/ Название объекта геозоны 4789 + "type": 0, ~/~/ Тип объекта геозоны 4790 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4791 + "fname": "string", ~/~/ Имя файла 4792 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4793 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4794 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4795 + "description": "string", ~/~/ Описание объекта геозоны 4796 + "area": 0, ~/~/ Площадь, м2 4797 + "perimetr": 0, ~/~/ Периметр, м 4798 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4799 + } 4800 +] 4801 + 4802 + 4803 +== **Создание нового поля ** == 4804 + 4805 +(% class="box successmessage" %) 4806 +((( 4807 +**POST /api/v3/agroLands** 4808 +))) 4809 + 4810 +Пример запроса: 4811 + 4812 +((( 4813 +{ 4814 + "extId": "string", 4815 + "shape": "string", ~/~/ Форма поля 4816 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 4817 + "display": "string", ~/~/ Настройки отображения 4818 + "year": 0, ~/~/ Год поля 4819 + "name": "string", ~/~/ Наименование 4820 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4821 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 4822 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 4823 + "planComment": "string", ~/~/ Комментарий к полю 4824 + "cropRotations": [ ~/~/ Данные по севообороту 4825 + { 4826 + "landId": 0, ~/~/ ID поля 4827 + "landName": "string", ~/~/ Название поля 4828 + "year": 0, ~/~/ Год урожая 4829 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4830 + "cultureName": "string", ~/~/ Название культуры 4831 + "productivity": 0, ~/~/ Урожайность 4832 + "area": 0, ~/~/ Площадь поля, Га 4833 + "total": 0, ~/~/ Валовый сбор 4834 + "productivityFact": 0, ~/~/ Фактическая урожайность 4835 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4836 + "totalFact": 0, ~/~/ Фактический валовый сбор 4837 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 4838 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 4839 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 4840 + "isyearplan": true, ~/~/ Годовой план 4841 + "comment": "string" ~/~/ Комментарий 4842 + } 4843 + ] 4844 +} 4845 +))) 4846 + 4847 +((( 4848 + 4849 +))) 4850 + 4851 +Пример ответа: 4852 + 4853 +((( 4854 +((( 4855 +{ 4856 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4857 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4858 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4859 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4860 + "cropRotations": [ ~/~/ Данные по севообороту 4861 + { 4862 + "landId": 0, ~/~/ ID поля 4863 + "landName": "string", ~/~/ Название поля 4864 + "year": 0, ~/~/ Год урожая 4865 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4866 + "cultureName": "string", ~/~/ Название культуры 4867 + "productivity": 0, ~/~/ Урожайность 4868 + "area": 0, ~/~/ Площадь поля, Га. 4869 + "total": 0, ~/~/ Валовый сбор 4870 + "productivityFact": 0, ~/~/ Фактическая урожайность 4871 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4872 + "totalFact": 0, ~/~/ Фактический валовый сбор 4873 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 4874 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 4875 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 4876 + "isyearplan": true, ~/~/ годовой план 4877 + "comment": "string" ~/~/ Комментарий 4878 + } 4879 + ], 4880 + "cropVegetation": [ ~/~/ История вегетации поля 4881 + { 4882 + "values": [ ~/~/ Данные вегетации и состояния посева 4883 + { 4884 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4885 + "ndvi": 0 ~/~/ Индекс вегетации 4886 + } 4887 + ], 4888 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4889 + { 4890 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4891 + "type": "string", ~/~/ Тип 4892 + "pictureid": "string" ~/~/ Идентификатор ресурса 4893 + } 4894 + ], 4895 + "states": [ ~/~/ Ключевые даты развития поля 4896 + { 4897 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 4898 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 4899 + } 4900 + ] 4901 + } 4902 + ], 4903 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 4904 + "counts": { 4905 + "fieldOperations": 0, ~/~/ Количество операций на поле 4906 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4907 + "facts": 0 ~/~/ Счётчик факта 4908 + }, 4909 + "planComment": "string", ~/~/ Комментарий к полю 4910 +))) 4911 + 4912 +((( 4913 + "productivity": 0, ~/~/ Урожайность. 4914 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4915 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 4916 + "year": 0, ~/~/ Год поля 4917 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4918 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4919 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4920 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 4921 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 4922 + "id": 0, ~/~/ Идентификатор объекта геозоны 4923 + "name": "string", ~/~/ Название объекта геозоны 4924 + "type": 0, ~/~/ Тип объекта геозоны 4925 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4926 + "fname": "string", ~/~/ Имя файла 4927 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4928 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 4929 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 4930 + "description": "string", ~/~/ Описание объекта геозоны 4931 + "area": 0, ~/~/ Площадь, м2 4932 + "perimetr": 0, ~/~/ Периметр, м 4933 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 4934 +} 4935 + 4936 + 4937 +))) 4938 +))) 4939 +))) 4940 + 4941 +== **Получение поля по id** == 4942 + 4943 +(% class="box infomessage" %) 4944 +((( 4945 +**GET /api/v3/agroLands/{id}** 4946 +))) 4947 + 4948 +Пример запроса: 4949 +id ~/~/ Идентификатор поля 4950 + 4951 +Пример ответа: 4952 + 4953 +((( 4954 +{ 4955 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4956 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4957 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4958 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4959 + "cropRotations": [ ~/~/ Данные по севообороту 4960 + { 4961 + "landId": 0, ~/~/ ID поля 4962 + "landName": "string", ~/~/ Название поля 4963 + "year": 0, ~/~/ Год урожая 4964 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 4965 + "cultureName": "string", ~/~/ Название культуры 4966 + "productivity": 0, ~/~/ Урожайность 4967 + "area": 0, ~/~/ Площадь поля, Га 4968 + "total": 0, ~/~/ Валовый сбор 4969 + "productivityFact": 0, ~/~/ Фактическая урожайность 4970 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 4971 + "totalFact": 0, ~/~/ Фактический валовый сбор 4972 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 4973 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 4974 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 4975 + "isyearplan": true, ~/~/ План года 4976 + "comment": "string" ~/~/ Комментарий 4977 + } 4978 + ], 4979 + "cropVegetation": [ ~/~/ История вегетации поля 4980 + { 4981 + "values": [ ~/~/ Данные вегетации и состояния посева 4982 + { 4983 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4984 + "ndvi": 0 ~/~/ Индекс вегетации 4985 + } 4986 + ], 4987 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 4988 + { 4989 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4990 + "type": "string", ~/~/ Тип 4991 + "pictureid": "string" ~/~/ Идентификатор ресурса 4992 + } 4993 + ], 4994 + "states": [ ~/~/ Ключевые даты развития поля 4995 + { 4996 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 4997 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 4998 + } 4999 + ] 5000 + } 5001 + ], 5002 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5003 + "counts": { 5004 + "fieldOperations": 0, ~/~/ Количество операций на поле 5005 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5006 + "facts": 0 ~/~/ Счётчик факта 5007 + }, 5008 + "planComment": "string", ~/~/ Комментарий к полю 5009 + "productivity": 0, ~/~/ Урожайность. 5010 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5011 +))) 5012 + 5013 +((( 5014 +((( 5015 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5016 + "year": 0, ~/~/ Год поля 5017 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5018 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5019 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5020 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5021 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5022 + "id": 0, ~/~/ Идентификатор объекта геозоны 5023 + "name": "string", ~/~/ Название объекта геозоны 5024 + "type": 0, ~/~/ Тип объекта геозоны 5025 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5026 + "fname": "string", ~/~/ Имя файла 5027 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5028 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5029 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5030 + "description": "string", ~/~/ Описание объекта геозоны 5031 + "area": 0, ~/~/ Площадь, м2 5032 + "perimetr": 0, ~/~/ Периметр, м 5033 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5034 +} 5035 +))) 5036 + 5037 + 5038 +== **Удаление существующего поля** == 5039 + 5040 +(% class="box errormessage" %) 5041 +((( 5042 +**DELETE /api/v3/agroLands/{id}** 5043 +))) 5044 + 5045 +Пример запроса: 5046 +id ~/~/ Идентификатор поля 5047 + 5048 +Пример ответа: 5049 + 5050 +((( 5051 +200 ~/~/ Успех 5052 +))) 5053 + 5054 +((( 5055 + 5056 +))) 5057 + 5058 +((( 5059 +((( 5060 +((( 5061 + 5062 +))) 5063 + 5064 +((( 5065 +== **Изменение поля** == 5066 + 5067 +(% class="box infomessage" %) 5068 +((( 5069 +**PUT /api/v3/agroLands** 5070 +))) 5071 + 5072 +Пример запроса: 5073 + 5074 +((( 5075 +((( 5076 +{ 5077 + "id": 0, ~/~/ Идентификатор поля 5078 + "extId": "string", ~/~/ ExtId 5079 + "shape": "string", ~/~/ Форма поля 5080 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5081 + "display": "string", ~/~/ Настройки отображения 5082 + "year": 0, ~/~/ Год поля 5083 + "name": "string", ~/~/ Наименование 5084 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5085 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5086 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5087 + "planComment": "string", ~/~/Комментарий к полю 5088 + "cropRotations": [ ~/~/ Данные по севообороту 5089 + { 5090 + "landId": 0, ~/~/ ID поля 5091 + "landName": "string", ~/~/ Название поля 5092 + "year": 0, ~/~/ Год урожая 5093 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5094 + "cultureName": "string", ~/~/ Название культуры 5095 + "productivity": 0, ~/~/ Урожайность 5096 + "area": 0, ~/~/ Площадь поля, Га. 5097 + "total": 0, ~/~/ Валовый сбор 5098 + "productivityFact": 0, ~/~/ Фактическая урожайность 5099 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5100 + "totalFact": 0, ~/~/ Фактический валовый сбор 5101 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5102 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5103 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5104 + "isyearplan": true, 5105 + "comment": "string" ~/~/ Комментарий 5106 + } 5107 + ], 5108 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5109 +} 5110 +))) 5111 +))) 5112 + 5113 +((( 5114 + 5115 +))) 5116 + 5117 +Пример ответа: 5118 + 5119 +((( 5120 +((( 5121 +((( 5122 +{ 5123 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5124 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5125 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5126 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5127 + "cropRotations": [ ~/~/ Данные по севообороту 5128 + { 5129 + "landId": 0, ~/~/ ID поля 5130 + "landName": "string", ~/~/ Название поля 5131 + "year": 0, ~/~/ Год урожая 5132 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5133 + "cultureName": "string", ~/~/ Название культуры 5134 + "productivity": 0, ~/~/ Урожайность 5135 + "area": 0, ~/~/ Площадь поля, Га 5136 + "total": 0, ~/~/ Валовый сбор 5137 + "productivityFact": 0, ~/~/ Фактическая урожайность 5138 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5139 + "totalFact": 0, ~/~/ Фактический валовый сбор 5140 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5141 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5142 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5143 + "isyearplan": true, ~/~/ 5144 + "comment": "string" ~/~/ Комментарий 5145 + } 5146 + ], 5147 + "cropVegetation": [ ~/~/ История вегетации поля 5148 + { 5149 + "values": [ ~/~/ Данные вегетации и состояния посева 5150 + { 5151 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5152 + "ndvi": 0 ~/~/ Индекс вегетации 5153 + } 5154 + ], 5155 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5156 + { 5157 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5158 + "type": "string", ~/~/ Тип 5159 + "pictureid": "string" ~/~/ Идентификатор ресурса 5160 + } 5161 + ], 5162 + "states": [ ~/~/ Ключевые даты развития поля 5163 + { 5164 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5165 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5166 + } 5167 + ] 5168 + } 5169 + ], 5170 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5171 + "counts": { 5172 + "fieldOperations": 0, ~/~/ Количество операций на поле 5173 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5174 + "facts": 0 ~/~/ Счётчик факта 5175 + }, 5176 + "planComment": "string", ~/~/ Комментарий к полю 5177 + "productivity": 0, ~/~/ Урожайность. 5178 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5179 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5180 + "year": 0, ~/~/ Год поля 5181 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5182 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5183 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5184 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5185 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5186 + "id": 0, ~/~/ Идентификатор объекта геозоны 5187 + "name": "string", ~/~/ Название объекта геозоны 5188 + "type": 0, ~/~/ Тип объекта геозоны 5189 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5190 + "fname": "string", ~/~/ Имя файла 5191 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5192 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5193 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5194 + "description": "string", ~/~/ Описание объекта геозоны 5195 + "area": 0, ~/~/ Площадь, м2 5196 + "perimetr": 0, ~/~/ Периметр, м 5197 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5198 +} 5199 +))) 5200 +))) 5201 +))) 5202 +))) 5203 +))) 5204 + 5205 + 5206 +== **Редактирование года урожая ** == 5207 + 5208 +(% class="box successmessage" %) 5209 +((( 5210 +**POST /api/v3/agroLands/updateOpenCloseYear** 5211 +))) 5212 + 5213 +Пример запроса: 5214 + 5215 +((( 5216 +((( 5217 +{ 5218 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5219 + 0 5220 + ], 5221 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5222 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5223 +} 5224 +))) 5225 + 5226 + 5227 +))) 5228 + 5229 +Пример ответа: 5230 + 5231 +((( 5232 +((( 5233 +{ 5234 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5235 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5236 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5237 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5238 + "cropRotations": [ ~/~/ Данные по севообороту 5239 + { 5240 + "landId": 0, ~/~/ ID поля 5241 + "landName": "string", ~/~/ Название поля 5242 + "year": 0, ~/~/ Год урожая 5243 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5244 + "cultureName": "string", ~/~/ Название культуры 5245 + "productivity": 0, ~/~/ Урожайность 5246 + "area": 0, ~/~/ Площадь поля, Га. 5247 + "total": 0, ~/~/ Валовый сбор 5248 + "productivityFact": 0, ~/~/ Фактическая урожайность 5249 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5250 + "totalFact": 0, ~/~/ Фактический валовый сбор 5251 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5252 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5253 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5254 + "isyearplan": true, ~/~/ 5255 + "comment": "string" ~/~/ Комментарий 5256 + } 5257 + ], 5258 + "cropVegetation": [ ~/~/ История вегетации поля 5259 + { 5260 + "values": [ ~/~/ Данные вегетации и состояния посева 5261 + { 5262 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5263 + "ndvi": 0 ~/~/ Индекс вегетации 5264 + } 5265 + ], 5266 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5267 + { 5268 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5269 + "type": "string", ~/~/ Тип 5270 + "pictureid": "string" ~/~/ Идентификатор ресурса 5271 + } 5272 + ], 5273 + "states": [ ~/~/ Ключевые даты развития поля 5274 + { 5275 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5276 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5277 + } 5278 + ] 5279 + } 5280 + ], 5281 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5282 + "counts": { 5283 + "fieldOperations": 0, ~/~/ Количество операций на поле 5284 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5285 + "facts": 0 ~/~/ Счётчик факта 5286 + }, 5287 + "planComment": "string", ~/~/ Комментарий к полю 5288 + "productivity": 0, ~/~/ Урожайность. 5289 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5290 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5291 + "year": 0, ~/~/ Год поля 5292 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5293 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5294 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5295 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5296 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5297 + "id": 0, ~/~/ Идентификатор объекта геозоны 5298 + "name": "string", ~/~/ Название объекта геозоны 5299 + "type": 0, ~/~/ Тип объекта геозоны 5300 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5301 + "fname": "string", ~/~/ Имя файла 5302 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5303 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5304 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5305 + "description": "string", ~/~/ Описание объекта геозоны 5306 + "area": 0, ~/~/ Площадь, м2 5307 + "perimetr": 0, ~/~/ ериметр, м 5308 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5309 +} 5310 +))) 5311 + 5312 + 5313 +== (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) == 5314 +))) 5315 +))) 5316 +))) 5317 + 5318 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5319 + 5320 + 5321 +(% class="box infomessage" %) 5322 +((( 5323 +**GET api/v3/Vehicles/recyclebin/all** 5324 +))) 5325 + 5326 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5327 + 5328 +Параметр запроса: {parentId} - идентификатор агента 5329 + 5330 +В заголовках запроса: X-Auth: Токен авторизации 5331 + 5332 +Ответ: 5333 + 5334 +[ 5335 + { 5336 + "recordTime": "", ~/~/Время записи 5337 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5338 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5339 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5340 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5341 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5342 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5343 + "items": [ ~/~/ 5344 +nullable: true ~/~/Детали 5345 + { 5346 + "name": "string", ~/~/наименование столбца 5347 + "value": "string" ~/~/содержание столбца 5348 + } 5349 + ] 5350 + }, 5351 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5352 + "string" 5353 + ] 5354 + } 5355 +] 5356 + 5357 + 5358 +(% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины** 5359 + 5360 +(% class="box infomessage" %) 5361 +((( 5362 +**POST api/v3/Vehicles/recyclebin/erase** 5363 +))) 5364 + 5365 +В заголовках запроса: X-Auth: Токен авторизации 5366 + 5367 +Пример запроса: 5368 + 5369 +[ 5370 +0 5371 +] 5372 + 5373 + 5374 +Пример ответа: 5375 + 5376 +[ 5377 +{ 5378 + "recordTime": "", ~/~/Время записи 5379 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5380 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5381 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5382 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5383 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5384 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5385 + "items": [ ~/~/Детали 5386 + { 5387 + "name": "", ~/~/Имя свойства 5388 + "value": "" ~/~/Значение свойства 5389 + } 5390 + ] 5391 + }, 5392 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5393 + "" 5394 + ] 5395 + } 5396 +] 5397 + 5398 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5399 + 5400 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5401 + 5402 +(% class="box infomessage" %) 5403 +((( 5404 +**POST api/v3/Vehicles/recyclebin/restore** 5405 +))) 5406 + 5407 +В заголовках запроса: X-Auth: Токен авторизации 5408 + 5409 +Параметры в теле запроса (JSON): 5410 + 5411 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5412 + 5413 +В заголовках запроса: X-Auth: Токен авторизации 5414 + 5415 + 5416 +Пример запроса: 5417 + 5418 +((( 5419 +[ 5420 +))) 5421 + 5422 +((( 5423 + 0 5424 +))) 5425 + 5426 +((( 5427 +] 5428 +))) 5429 + 5430 + 5431 +Пример ответа: 5432 + 5433 +[ 5434 +{ 5435 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5436 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5437 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5438 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5439 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5440 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5441 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5442 + "items": [ ~/~/Детали 5443 + { 5444 + "name": "string", ~/~/Имя свойства 5445 + "value": "string" ~/~/Значение свойства 5446 + } 5447 + ] 5448 + }, 5449 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5450 + "string" 5451 + ] 5452 + } 5453 +] 5454 + 5455 + 5456 + 3356 3356 (% class="box" lang="en-US" style="text-align: center;" %) 3357 3357 ((( 3358 3358 (% 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