Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/09/16 11:13
Change comment:
There is no comment for this version
Summary
Details
- Page properties
-
- Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. krainovim1 +XWiki.Gadmin - Content
-
... ... @@ -1,5 +1,22 @@ 1 1 (% class="western" id="H41E43F43844143043D43843541341B41E41D410421421SoftPublicAPI" %) 2 2 ((( 3 +(% class="box warningmessage" %) 4 +((( 5 +(% class="mark" %)##Для обеспечения бесперебойной работы команд и серверного оборудования ГЛОНАССSoft убедительно 6 +просим вас соблюдать несколько простых правил при использовании API-команд:## 7 +))) 8 + 9 +* Формировать не более 3 отчётов одновременно. 10 +* Ограничить количество активных сессий одного пользователя с одного IP-адреса до 50. 11 + 12 +В случае нарушения этих правил, ГЛОНАССSoft оставляет за собой право принудительно остановить выполнение запросов с определенных IP адресов. 13 + 14 +(% class="box infomessage" %) 15 +((( 16 +**Чтобы избежать блокировки** из-за превышения количества авторизаций, вам необходимо использовать токен авторизации, полученный с помощью метода /auth/login, во всех последующих запросах к API. Этот токен имеет ограниченный срок действия, который можно изменить, настроив параметр "Длительность сессии" в настройках пользователя. 17 +\\При выполнении запросов с одним и тем же токеном его срок действия автоматически продлевается. Это позволяет пройти авторизацию только один раз и использовать полученный токен во всех последующих запросах без необходимости повторного входа в систему. 18 +))) 19 + 3 3 **Содержание страницы:** 4 4 ))) 5 5 ... ... @@ -14,13 +14,22 @@ 14 14 15 15 Пример: X-Auth: 34f4919a-099b-4b7d-8aa1-f478ec2062de. 16 16 17 -(% style="color:#000000" %)− (%%)При редактировании необходимо передавать все параметры пользователяв теле запроса! Те параметры, значения которых не будут переданы - будут стерты!34 +(% style="color:#000000" %)− (%%)При **редактировании** любой записи (пользователь, объект и т.д) необходимо передавать все параметры записи в теле запроса! Те параметры, значения которых не будут переданы - будут стерты! 18 18 36 + 37 +(% style="color:#000000; font-size:16px" %)**Рекомендации** 38 + 39 +- Для запросов по API рекомендуется наделить пользователя ролью **Администратора партнера**, в противном случае при выполнении некоторых запросов у него не будет хватать прав (чаще всего сталкиваются с отсутствием прав при запросах сообщений от терминала за период). 40 + 19 19 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Авторизация**(%%) = 20 20 21 -== (% style="color:#000000; font-size:16px" %)**Авторизация**(%%) == 43 +(% class="box warningmessage" id="H41043244243E44043843743044643844F" %) 44 +((( 45 +(% style="color:#000000; font-size:16px" %)**Авторизация**(%%) 46 +(% style="color:#000000; font-size:16px" %)Адрес сервера всегда следует указывать именно тот, по которому происходит вход в СМТ (https:~/~/hosting.glonasssoft.ru/ , [[https:~~/~~/regions.glonasssoft.ru/>>https://regions.glonasssoft.ru/]] или другие) 47 +))) 22 22 23 -(% class="box infomessage" %)49 +(% class="box successmessage" %) 24 24 ((( 25 25 (% lang="en-US" %)**POST /api/v3/auth/login** 26 26 ))) ... ... @@ -31,7 +31,7 @@ 31 31 32 32 (% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/auth/login>>https://hosting.glonasssoft.ru/api/v3/auth/login]] 33 33 34 -(% style="color:#000000" %)В случае успешного выполнения метода, поле « __**AuthId**__» содержит токен авторизации «__**X-Auth**__».60 +(% style="color:#000000" %)В случае успешного выполнения метода, поле «AuthId» содержит токен авторизации «X-Auth». 35 35 36 36 (% style="color:#000000" %)Параметры в теле запроса (JSON): 37 37 ... ... @@ -40,21 +40,25 @@ 40 40 "password": "testuser" 41 41 } 42 42 43 - 44 44 (% style="color:#000000" %)**Ответ:** 45 45 46 46 (% lang="en-US" %) 47 47 (% style="color:#000000" %){ 48 - 49 -(% lang="en-US" %) 50 -(% style="color:#000000" %) "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 51 - "User": "testuser" , ~/~/ имя пользователя 52 - 53 -(% lang="en-US" %) 73 + "AuthId": "(%%)93c6jg79-b88b-4a35-a2d0-70dg9jc2898b(% style="color:#000000" %)" , ~/~/ токен авторизации 74 + "User": "testuser" , ~/~/ имя пользователя(%%) 54 54 } 55 55 56 56 **Примечание: **Время жизни токена авторизации задается в настройках пользователя, там есть параметр длительность сессии. При каждом запросе токен пролонгируется. 57 57 79 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 80 +|(% style="width:215px" %)(% style="color:#000000" %)login|(% style="width:861px" %)Логин пользователя 81 +|(% style="width:215px" %)(% style="color:#000000" %)password|(% style="width:861px" %)Пароль пользователя 82 +|(% style="width:215px" %)(% style="color:#000000" %)AuthId|(% style="width:861px" %)Токен авторизации 83 +|(% style="width:215px" %)(% style="color:#000000" %)User|(% style="width:861px" %)Логин пользователя 84 + 85 +(% class="wikigeneratedid" %) 86 +Также имеется возможность сквозной (/бесшовной) авторизации. Для этого к ссылке ( [[https:~~/~~/hosting.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]] / [[https:~~/~~/regions.glonasssoft.ru>>url:https://hosting.glonasssoft.ru/login?authId={AuthId}]]) добавьте токен авторизации - {AuthId}, чтобы попасть сразу в клиента ([[https:~~/~~/hosting.glonasssoft.ru/login?authId={AUTH_ID}>>https://hosting.glonasssoft.ru/login?authId={AUTH_ID}]]) 87 + 58 58 == (% style="color:#000000; font-size:16px" %)**Проверка авторизации**(%%) == 59 59 60 60 (% class="box infomessage" %) ... ... @@ -93,30 +93,63 @@ 93 93 Запрос должен содержать данные параметра "**agentId**" 94 94 95 95 (% style="color:#000000" %)Ответ: 96 -А 126 + 127 +((( 97 97 { 98 - "agentId": "", ~/~/ идентификатор клиента (%%) 99 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 100 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 101 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 102 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 103 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) 104 - "isForeign": true/false, ~/~/ Иностранный контрагент 105 - "district": "string", ~/~/ округ 106 - "region": "string", ~/~/ регион 107 - "city": "string", ~/~/ город 108 - "inn": "string", ~/~/ ИНН клиента 109 - "kpp": "string", ~/~/ КПП клиента 110 - "address": "string", ~/~/ юридический адрес 111 - "addressFact": "string", ~/~/ фактический адрес 112 - "email": "string", ~/~/ почта 113 - "director": "string", ~/~/ ФИО руководителя 114 - "bankName": "string", ~/~/ Банк 115 - "bankBIK": "string", ~/~/ БИК 116 - "bankRS": "string", ~/~/ Номер счета 117 - "bankKS": "string" ~/~/ Корр. счет 118 - } 129 + "agentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID клиента 130 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID родителя 131 + "parentName": "string", ~/~/ Наименование агента 132 + "name": "string", ~/~/ Имя клиента 133 + "fullName": "string", ~/~/ ФИО клиента 134 + "agentInfoType": 0, ~/~/ Тип клиента ((% style="color:#000000" %)0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор(%%)) 135 + "isForeign": true, ~/~/ Флаг "Иностранный контрагент" 136 + "district": "string", ~/~/ Район 137 + "region": "string", ~/~/ Область 138 + "city": "string", ~/~/ Город 139 + "email": "string", ~/~/ Email 140 + "director": "string", ~/~/ Руководитель 141 + "RegionalData": [ ~/~/ Определяет региональные сведения. 142 + { 143 + "Country": 0, ~/~/ Страна 144 + "groups": [ ~/~/ Список групп 145 + { 146 + "groupId": "string", ~/~/ Уникальный идентификатор группы 147 + "fields": [ ~/~/ Список значений полей 148 + { 149 + "name": "string", ~/~/ Имя поля формы 150 + "value": "string" ~/~/ Значение поля формы 151 + } 152 + ] 153 + } 154 + ] 155 + } 156 + ] 157 +} 158 +))) 119 119 160 + 161 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 162 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 163 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 164 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 165 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 166 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 167 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 168 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 169 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 170 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 171 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 172 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 173 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 174 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 175 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 176 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 177 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 178 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 179 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 180 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 181 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 182 + 120 120 == (% style="color:#000000; font-size:16px" %)**Получение параметров дочерних клиентов**(%%) == 121 121 122 122 (% class="box infomessage" %) ... ... @@ -130,7 +130,7 @@ 130 130 131 131 (% style="color:#000000" %)− возвращается информация о клиенте, которому принадлежит авторизованный пользователь, и его дочерних клиентах; 132 132 133 -(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его подклиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__».196 +(% style="color:#000000" %)− информация о клиенте типа «Партнер» и его клиентов возвращается при наличии права «__**Доступ к партнёрским клиентам**__». 134 134 135 135 (% style="color:#000000" %)Метод запроса: **POST** 136 136 ... ... @@ -145,15 +145,23 @@ 145 145 (% style="color:#000000" %)Ответ: 146 146 147 147 { 148 - "agentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента (%%) 149 - "parentId": "", (% style="color:#000000" %)~/~/ идентификатор клиента-родителя(%%) 150 - "parentName": "string", ~/~/ наименование (% style="color:#000000" %)клиента-родителя(%%) 151 - "name": "string", (% style="color:#000000" %)~/~/ наименование клиента (%%) 152 - "fullName": "string", (% style="color:#000000" %)~/~/ полное наименование клиента(%%) 153 - "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 154 - "status": "",~/~/ статус клиента (0- Новый, 1 - Потенциальный, 2 - В разработке, 3 - Тест, 4 - На оформлении, 5 - Внедрение, 6 - Работает, 7 - Работал, 8 - Потерян, 9 - Отказ) 211 + "agentId": "",(% style="color:#000000" %) (%%) 212 + "parentId": "", 213 + "name": "string", 214 + "fullName": "string", 215 + "agentInfoType": 0, 216 +(% style="color:#000000" %) "status": "", 155 155 } 156 156 219 + 220 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 221 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 222 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 223 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 224 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 225 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 226 +|(% style="width:215px" %)(% style="color:#000000" %)status|(% style="width:861px" %)Статус клиента, 0 - заблокирован, 1 - Активен 227 + 157 157 == (% style="color:#000000; font-size:16px" %)**Добавление клиента**(%%) == 158 158 159 159 (% class="box successmessage" %) ... ... @@ -172,7 +172,7 @@ 172 172 Параметры в теле запроса (JSON): 173 173 174 174 { 175 - 246 + "parentId": "00000000-0000-0000-0000-000000000000", ~/~/ идентификатор клиента-родителя 176 176 "name": "string", ~/~/ имя 177 177 "fullName": "string", ~/~/ полное наименование 178 178 "agentInfoType": 0, (% style="color:#000000" %)~/~/ тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор)(%%) ... ... @@ -192,7 +192,6 @@ 192 192 "bankKS": "string" ~/~/ корр. счёт 193 193 } 194 194 195 - 196 196 Ответ: 197 197 198 198 { ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 371 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 372 + 373 +(% class="box warningmessage" %) 374 +((( 375 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 376 +))) 377 + 378 +Метод позволяет изменить статус клиента, указанного в запросе. 379 + 380 +В пути указывается GUID клиента и статус клиента. 381 + 382 +**status **- значение 0 - заблокирован, 1 - активен. 383 + 384 +Ответ: Code 204 385 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -349,9 +349,8 @@ 349 349 [ 350 350 "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ группы пользователя, перечисление названия клиентских ролей 351 351 ], 352 - "language": 0~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский435 + "language": 1 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 450 +{ 451 + "id": "" , ~/~/ ID пользователя 375 375 "lastName": "" , ~/~/ Фамилия , 376 376 "firstName": "" , ~/~/ Имя 377 377 "position": "" , ~/~/ Должность ... ... @@ -388,9 +388,8 @@ 388 388 "kind": "" , ~/~/ тип аутентификации 389 389 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 390 390 "groups": (% style="color:#000000" %)["", ""] (% style="color:#000000; font-weight:normal" %), ~/~/ роли пользователя, перечислены названия групп пользователя 468 +} 391 391 392 -(% style="text-align:left" %) 393 -(% style="color:#000000; font-weight:normal" %)} 394 394 395 395 == (% style="color:#000000; font-size:16px" %)**Получение списка пользователей**(%%) == 396 396 ... ... @@ -411,19 +411,16 @@ 411 411 412 412 (% style="color:#000000" %)Параметры в теле запроса (JSON): 413 413 414 -(% style="color:#000000" %){ 415 - 490 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -436,8 +436,7 @@ 436 436 "email": "" , ~/~/ E-mail 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 - "astLogged": "", ~/~/ дата/время последней авторизации 440 - 512 + "lastLogged": "", ~/~/ дата/время последней авторизации 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 586 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 587 + "id": "" , ~/~/ ID пользователя 518 518 "lastName": "" , ~/~/ фамилия 519 519 "firstName": "" , ~/~/ имя 520 520 "position": "" , ~/~/ должность ... ... @@ -536,9 +536,7 @@ 536 536 "target": "string" ~/~/ Адрес электронной почты двухэтапной аутентификации 537 537 }, 538 538 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 539 - "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 540 - 541 -(% lang="en-US" style="text-align:left" %) 609 + "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя(%%) 542 542 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)__}__ 543 543 544 544 (% lang="en-US" style="text-align:left" %) ... ... @@ -545,10 +545,8 @@ 545 545 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)//Ответ~:// 546 546 547 547 (% lang="en-US" style="text-align:left" %) 548 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 549 - 550 -(% lang="en-US" style="text-align:left" %) 551 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ идентификатор пользователя 616 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 617 + "id": "" , ~/~/ идентификатор пользователя 552 552 "lastName": "" , ~/~/ фамилия 553 553 "firstName": "" , ~/~/ имя 554 554 "position": "" , ~/~/ должность ... ... @@ -569,10 +569,8 @@ 569 569 "isDisabledMobile": false, ~/~/ Запретить использовать мобильное приложение, true - включен, false - отключен 570 570 "target": "" , ~/~/ в случае аутентификации по email - email-адрес 571 571 "groups": "" , ~/~/ группы пользователя, «user» названия группы пользователя 638 +} 572 572 573 -(% lang="en-US" style="text-align:left" %) 574 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 575 - 576 576 == (% style="color:#000000; font-size:16px" %)**Изменение статуса пользователя**(%%) == 577 577 578 578 (% class="box warningmessage" %) ... ... @@ -592,12 +592,10 @@ 592 592 593 593 (% style="color:#000000" %)Параметры в теле запроса (JSON): 594 594 595 -(% style="color:#000000" %){ 596 - 659 +(% style="color:#000000" %){(%%) 597 597 "status": "" , ~/~/ статус пользователя (0 - новый, 1 - подтверждён, 2 - активен, 3 - уточнить, 4 - блокирован) 598 598 "description": "" , ~/~/ описание 599 599 "data": "" , ~/~/ данные, связанные со сменой статуса 600 - 601 601 (% style="color:#000000" %)} 602 602 603 603 (% style="text-align:left" %) ... ... @@ -619,7 +619,7 @@ 619 619 (% style="color:#000000" %)В теле запроса перечисляете массив id пользователей (JSON): 620 620 621 621 [ 622 - 684 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,8 +682,256 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 747 +(% class="wikigeneratedid" id="H" %) 748 +((( 749 + 750 +))) 686 686 752 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 753 + 754 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 755 + 756 +(% class="box infomessage" %) 757 +((( 758 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 759 +))) 760 + 761 +Метод возвращает полную информацию о модели объекта. 762 + 763 +(% style="color:#000000" %)Метод запроса: **GET** 764 + 765 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 766 + 767 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 768 + 769 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 770 + 771 +(% style="color:#000000" %)Ответ: 772 + 773 +(% style="color:#000000" %){ 774 + "parentName": "string", 775 + "name": "string", 776 + "picture": "string", 777 + "minspeed": 0, 778 + "maxspeed": 0, 779 + "width": 0, 780 + "imbeddedtrailer": true, 781 + "hoppercapacity": 0, 782 + "hopperdischargespeed": 0, 783 + "modelType": 0, 784 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 785 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 786 + "deleted": true 787 +} 788 + 789 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 790 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 791 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 792 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 793 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 794 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 795 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 796 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 797 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 798 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 799 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 800 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 801 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 802 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 803 + 804 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 805 + 806 +(% class="box successmessage" %) 807 +((( 808 +(% lang="en-US" %)**POST /api/v3/models/find** 809 +))) 810 + 811 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 812 + 813 +(% style="color:#000000" %)Метод запроса: **POST** 814 + 815 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 816 + 817 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 818 + 819 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 820 + 821 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 822 +} 823 + 824 +(% style="color:#000000" %)Ответ: 825 + 826 +(% style="color:#000000" %)[ 827 + { 828 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 829 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 830 + "parentName": "string", 831 + "name": "string", 832 + "modelType": 0 833 + } 834 +] 835 + 836 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 837 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 838 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 839 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 840 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 841 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 842 + 843 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 844 + 845 +(% class="box successmessage" %) 846 +((( 847 +(% lang="en-US" %)**POST /api/v3/models** 848 +))) 849 + 850 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 851 + 852 +(% style="color:#000000" %)Метод запроса: **POST** 853 + 854 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 855 + 856 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 857 + 858 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 859 + 860 +{ 861 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 862 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 863 + "deleted": false, 864 + "extId": "string", 865 + "name": "string", 866 + "picture": "string", 867 + "minspeed": 0, 868 + "maxspeed": 0, 869 + "width": 0, 870 + "imbeddedtrailer": true, 871 + "fueloutlay": 0, 872 + "hoppercapacity": 0, 873 + "hopperdischargespeed": 0, 874 + "modelType": 0 875 +} 876 + 877 +Ответ: 878 + 879 +{ 880 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 881 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 882 + "deleted": false, 883 + "extId": "string", 884 + "name": "string", 885 + "picture": "string", 886 + "minspeed": 0, 887 + "maxspeed": 0, 888 + "width": 0, 889 + "imbeddedtrailer": true, 890 + "hoppercapacity": 0, 891 + "hopperdischargespeed": 0, 892 + "modelType": 0 893 +} 894 + 895 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 896 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 897 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 898 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 899 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 900 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 901 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 902 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 903 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 904 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 905 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 906 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 907 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 908 + 909 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 910 + 911 +(% class="box warningmessage" %) 912 +((( 913 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 914 +))) 915 + 916 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 917 + 918 +(% style="color:#000000" %)Метод запроса: **PUT** 919 + 920 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 921 + 922 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 923 + 924 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 925 + 926 +{ 927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 928 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 929 + "deleted": true, 930 + "extId": "string", 931 + "name": "string", 932 + "picture": "string", 933 + "minspeed": 0, 934 + "maxspeed": 0, 935 + "width": 0, 936 + "imbeddedtrailer": true, 937 + "fueloutlay": 0, 938 + "hoppercapacity": 0, 939 + "hopperdischargespeed": 0, 940 + "modelType": 0 941 +} 942 + 943 +Ответ: 944 + 945 +{ 946 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 947 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 948 + "deleted": true, 949 + "extId": "string", 950 + "name": "string", 951 + "picture": "string", 952 + "minspeed": 0, 953 + "maxspeed": 0, 954 + "width": 0, 955 + "imbeddedtrailer": true, 956 + "fueloutlay": 0, 957 + "hoppercapacity": 0, 958 + "hopperdischargespeed": 0, 959 + "modelType": 0 960 +} 961 + 962 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 963 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 964 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 965 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 966 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 967 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 968 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 969 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 970 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 971 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 972 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 973 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 974 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 975 + 976 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 977 + 978 +(% class="box errormessage" %) 979 +((( 980 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 981 +))) 982 + 983 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 984 + 985 +(% style="color:#000000" %)Метод запроса: **DELETE** 986 + 987 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 988 + 989 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 990 + 991 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 992 + 993 +Ответ: В случае успеха **Success 200** 994 + 995 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 996 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -701,9 +701,9 @@ 701 701 702 702 (% style="color:#000000" %)Метод запроса: **GET** 703 703 704 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %) <(% lang="en-US" %)v(%%)ehicleID>1014 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/vehicles/>>url:https://hosting.glonasssoft.ru/api/v3/vehicles/]](% style="color:#000000" %){(% lang="en-US" %)v(%%)ehicleID} 705 705 706 -(% style="color:#000000" %)Параметр запроса: <__**vehicleid**__>- идентификатор объекта (опционально)1016 +(% style="color:#000000" %)Параметр запроса: {__**vehicleid}**__ - идентификатор объекта (integer($int32)) 707 707 708 708 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 709 709 ... ... @@ -711,6 +711,17 @@ 711 711 712 712 ((( 713 713 { 1024 + 1025 +((( 1026 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1027 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1028 +))) 1029 + 1030 +((( 1031 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1032 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1033 +))) 1034 + 714 714 "vehicleId": "", ~/~/ ID объекта 715 715 "name": "", ~/~/ Имя объекта 716 716 "imei": "", ~/~/ IMEI объекта ... ... @@ -717,20 +717,130 @@ 717 717 "deviceTypeId": , ~/~/ ID типа устройства 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 - "parentId": "", Номер SIM2 721 - "parentName": "", Наименование клиента-родителя 722 - "modelId": "", ID модели объекта 723 - "modelName": "", Имя модели объекта 724 - "createdAt": "", Дата создания объекта 725 - "mileageCalcMethod": "", Выбранный метод расчета пробега 726 - "counters": { ~/~/ Нормы 727 - "mileageEnabled": "", ~/~/ Флаг активности счётчика "Пробег" (true - включен, false - отключен) 728 - "motohoursEnabled": "", ~/~/ флаг активности счётчика "Моточасы" (true - включен, false - отключен) 729 - "mileage": "", ~/~/ Пробег по нормам в метрах 730 - "motohours": "" ~/~/ Моточасы по нормам, в секундах 731 - "mileageTime": "2023-03-14T11:18:52.696Z", ~/~/ временная метка редактирования/обновления счетчика пробега 732 - "motohoursTime": "2023-03-14T11:18:52.696Z" ~/~/ временная метка редактирования/обновления счетчика моточасов 1041 + "sim2": "", ~/~/ Номер SIM2 1042 + "parentId": "", ~/~/ ID клиента-родителя 1043 + "parentName": "", ~/~/ Наименование клиента-родителя 1044 + "modelId": "", ~/~/ ID модели объекта 1045 + "modelName": "", ~/~/ Имя модели объекта 1046 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1047 + "unitName": "string", ~/~/ Наименование подразделения 1048 + "status": 0, ~/~/ Статус объекта 1049 + "createdAt": "", ~/~/ Дата создания объекта 733 733 }, 1051 +"customFields": [ ~/~/ Произвольные поля 1052 + { 1053 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля 1054 + "name": "string", ~/~/ Имя поля 1055 + "value": "string", ~/~/ Значение поля 1056 + "forClient": true, ~/~/ Не используемая функция 1057 + "forTooltip": true, ~/~/ Отображать в подсказке 1058 + "forReport": true ~/~/ Отображать в отчете 1059 + } 1060 + 1061 +], ~/~/ Данные с вкладки нормы 1062 + "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1063 + "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1064 + "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу 1065 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1066 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1067 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1068 + "consumptionPer100KmSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1069 + "consumptionPer100KmSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1070 + "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1071 + "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1072 + "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1073 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1074 + "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 1075 + "mileageCoeff": 0, ~/~/ коэффициент пробега 1076 + "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна 1077 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат, true - активна, false - не активна 1078 + "counters": { ~/~/ Счетчики 1079 + "mileageEnabled": true, ~/~/ Считать текущий пробег, true - активна, false - не активна 1080 + "motohoursEnabled": true, ~/~/ Считать текущие моточасы, true - активна, false - не активна 1081 + "mileage": 0, ~/~/ Текущий пробег 1082 + "motohours": 0, ~/~/ Текущие моточасы 1083 + "mileageTime": "2023-05-22T09:57:39.562Z", ~/~/ Дата пересчета последнего пробега 1084 + "motohoursTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата пересчета последних моточасов 1085 + }, 1086 + 1087 +"cmsv6Parameters": { ~/~/ Настройки видеомониторинга 1088 + "id": "string", ~/~/ ID объекта 1089 + "enabled": true, ~/~/ Включить, true - активна, false - не активна 1090 + "host": "string", ~/~/ CMSV6 Web Host 1091 + "login": "string", ~/~/ CMSV6 Account 1092 + "password": "string" ~/~/ CMSV6 Password 1093 + }, 1094 + 1095 +"commandTemplates": [ ~/~/ Шаблоны команд 1096 + { 1097 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID команды 1098 + "name": "string", ~/~/ Наименование команды 1099 + "command": "string", ~/~/ Текст команды 1100 + "retries": 0 ~/~/ Количество попыток 1101 + } 1102 + ], 1103 + "sensors": [ ~/~/ Датчики 1104 + { 1105 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1106 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1107 + "type": 0, ~/~/ Тип датчика 1108 + "name": "string", ~/~/ Имя датчика 1109 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1110 + "inputNumber": 0, ~/~/ Номер входа 1111 + "pseudonym": "string", ~/~/ Псевдоним 1112 + "medianDegree": 0, ~/~/ Медианная фильтрация 1113 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1114 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1115 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1116 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1117 + { 1118 + "grades": [ ~/~/ Таблица тарировки 1 1119 + { 1120 + "input": 0, ~/~/ Входящее значение 1121 + "output": 0 ~/~/ Выходящее значение 1122 + } 1123 + ], 1124 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1125 + } 1126 + ], 1127 + "showInTooltip": true, ~/~/ Отображать в подсказке 1128 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1129 + "color": "string", ~/~/ Код цвета датчиков 1130 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1131 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1132 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1133 + "expr": "string", ~/~/ Формула 1134 + "children": [ ~/~/ массив дочерних датчиков 1135 + "string" 1136 + ], 1137 + "customParams": { ~/~/ прочие произвольные параметры 1138 + "additionalProp1": "string", 1139 + "additionalProp2": "string", 1140 + "additionalProp3": "string" 1141 + }, 1142 + 1143 +~/~/ Характерные для произвольного: 1144 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1145 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1146 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1147 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1148 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1149 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1150 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1151 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1152 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1153 +~/~/ "ValueOn": "Вкл.", 1154 +~/~/ "ValueOff": "Выкл." 1155 + "summaryMaxValue": 0 ~/~/ Макс. значение 1156 + } 1157 + "drivers": [ ~/~/ Водители 1158 + { 1159 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1160 + "name": "string", ~/~/ Наименование 1161 + "description": "string", 1162 + "isDefault": true ~/~/ По умолчанию 1163 + } 1164 + ], 734 734 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 735 735 { 736 736 "id": "", ~/~/ ID задания ... ... @@ -746,10 +746,28 @@ 746 746 "lastInspectionDate": "" ~/~/ Дата последнего ТО (null - не указано) 747 747 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 748 748 } 749 - ] 1180 + ], 1181 +"statusHistory": [ ~/~/ История статусов 1182 + { 1183 + "status": 0, 1184 + "date": "2023-05-22T09:57:39.562Z", 1185 + "description": "string", 1186 + "additionalInfo": "string" 1187 + 1188 +((( 750 750 } 1190 + ], 1191 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1192 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 751 751 ))) 752 752 1195 +((( 1196 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1197 +} 1198 + 1199 +))) 1200 +))) 1201 + 753 753 (% style="text-align:left" %) 754 754 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 755 755 ... ... @@ -756,6 +756,75 @@ 756 756 (% style="text-align:left" %) 757 757 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 758 758 1208 + 1209 +== **Отправить команду на терминал** == 1210 + 1211 +(% class="box successmessage" %) 1212 +((( 1213 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1214 +))) 1215 + 1216 +Команда для отправки на тс. 1217 + 1218 +{ 1219 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1220 +"command": "", ~/~/ Текст отправляемой команды 1221 +"retries": "", ~/~/ Количество попыток отправки на терминал 1222 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1223 +} 1224 + 1225 +В ответ получаем cmdid 1226 + 1227 + 1228 +== **Получить ответ на отправленную на ТС команду** == 1229 + 1230 +(% class="box infomessage" %) 1231 +((( 1232 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1233 +))) 1234 + 1235 +Идентификатор команды: cmdId 1236 + 1237 +Запрос от терминала на ответ команды 1238 + 1239 +Пример ответ от терминала: 1240 + 1241 +ID= "" ~/~/ идентификатор объекта 1242 +Soft="" ~/~/ версия софта 1243 +GPS=4 ~/~/ тип трекера 1244 +Time=11:05:43 28.06.24 ~/~/ время запроса 1245 +Lat=45.056221 ~/~/ широта 1246 +Lon=39.035938 ~/~/ долгота 1247 +Speed=0.0 ~/~/ скорость 1248 +Course=181.4 ~/~/направление 1249 + 1250 +((( 1251 +== **Список отправленных объекту команд с ответами** == 1252 + 1253 +(% class="box infomessage" %) 1254 +((( 1255 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1256 +))) 1257 + 1258 +Идентификатор ТС: vehicleId 1259 + 1260 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1261 + 1262 +Пример ответа терминала 1263 + 1264 +[ 1265 +{ 1266 +"id": "", ~/~/ идентификатор пользователя 1267 +"commandText": "", ~/~/Текст команды. 1268 +"templateId": "", ~/~/Идентификатор шаблона 1269 +"updated": "", ~/~/ Время отправки 1270 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1271 +"answer": "", ~/~/ Ответ терминала. 1272 +"status": "" ~/~/ Статус отправки 1273 +} 1274 +] 1275 +))) 1276 + 759 759 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 760 760 761 761 (% class="box successmessage" %) ... ... @@ -763,7 +763,7 @@ 763 763 (% lang="en-US" %)**POST /api/v3/vehicles** 764 764 ))) 765 765 766 -(% style="color:#000000" %)Метод позволяет добавить объект . Метод позволяет добавить объект, указанный в запросе.1284 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 767 767 768 768 (% style="color:#000000" %)Метод запроса: **POST** 769 769 ... ... @@ -775,6 +775,11 @@ 775 775 776 776 (% style="color:#000000" %){ 777 777 1296 + 1297 +((( 1298 + "vehicleId": 0, ~/~/ ID ТС 1299 +))) 1300 + 778 778 "parentId": "" , ~/~/ ID клиента 779 779 "name": "" , ~/~/ имя ТС 780 780 "imei": "" , ~/~/ IMEI ... ... @@ -795,6 +795,10 @@ 795 795 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 796 796 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 797 797 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1321 + "mileageCalcMethod": 0, 1322 + "mileageCoeff": 0, 1323 + "locationByCellId": true, 1324 + "dottedLineTrackWhenNoCoords": true, 798 798 "counters": ~/~/ счетчики 799 799 { 800 800 "mileage": "" , ~/~/ пробег ... ... @@ -823,67 +823,275 @@ 823 823 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 824 824 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 825 825 } 1353 +"drivers": [ ~/~/ Водители 1354 + { 1355 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1356 + "isDefault": true 1357 + } 1358 + ], 1359 + "commandTemplates": [ ~/~/ Шаблон команды 1360 + { 1361 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1362 + "name": "string", 1363 + "command": "string", 1364 + "retries": 0 1365 + } 1366 + ], 1367 +"sensors": [ ~/~/ Датчики 1368 + { 1369 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1370 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1371 + "type": 0, ~/~/ Тип датчика 1372 + "name": "string", ~/~/ Имя датчика 1373 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1374 + "inputNumber": 0, ~/~/ Номер входа 1375 + "pseudonym": "string", ~/~/ Псевдоним 1376 + "medianDegree": 0, ~/~/ Медианная фильтрация 1377 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1378 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1379 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1380 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1381 + { 1382 + "grades": [ ~/~/ Таблица тарировки 1 1383 + { 1384 + "input": 0, ~/~/ Входящее значение 1385 + "output": 0 ~/~/ Выходящее значение 1386 + } 1387 + ], 1388 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1389 + } 1390 + ], 1391 + "showInTooltip": true, ~/~/ Отображать в подсказке 1392 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1393 + "color": "string", ~/~/ код цвета датчиков 1394 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1395 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1396 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1397 + "expr": "string", ~/~/ Формула 1398 + "children": [ ~/~/ массив дочерних датчиков 1399 + "string" 1400 + ], 1401 + "customParams": { ~/~/ прочие произвольные параметры 1402 + "additionalProp1": "string", 1403 + "additionalProp2": "string", 1404 + "additionalProp3": "string" 1405 + }, 1406 +~/~/ Характерные для произвольного: 1407 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1408 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1409 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1410 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1411 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1412 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1413 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1414 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1415 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1416 +~/~/ "ValueOn": "Вкл.", 1417 +~/~/ "ValueOff": "Выкл." 1418 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 826 826 827 -(% style="color:#000000" %) } 1420 +((( 1421 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1422 + { 1423 + "from": 0, ~/~/ С какого значения 1424 + "color": "string", ~/~/ Каким цветом 1425 + "text": "string" ~/~/ Текст подписи к этому интервалу 1426 + } 1427 + ] 1428 + } 1429 + ], 1430 +))) 828 828 1432 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1433 + 1434 + 1435 + "customFields": [ ~/~/ Произвольные поля 1436 + { 1437 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1438 + "name": "string", ~/~/ Наименование произвольного поля 1439 + "value": "string", ~/~/ Значение произвольного поля 1440 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1441 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1442 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1443 + 1444 +((( 1445 + } 1446 + ], 1447 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1448 +))) 1449 + 1450 +((( 1451 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1452 +} 1453 +))) 1454 + 1455 + 829 829 (% style="color:#000000" %)Ответ: 830 830 831 -(% style="color:#000000" %){ 832 832 833 - "vehicleId": "", ~/~/ID ТС 834 - "parentId": "", ~/~/Guid владельца ТС 835 - "name": "", ~/~/Имя объекта 836 - "imei": "", ~/~/IMEI 837 - "deviceTypeId": "", ~/~/ID типа устройства 838 - "modelId": "", ~/~/ID модели 839 - "unitId": "", ~/~/ID подразделения 840 - "sim1": "", ~/~/SIM1 841 - "sim2": "", ~/~/SIM2 842 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 843 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 844 - "counters": { ~/~/Счётчики 845 - "mileageEnabled": true, 846 - "motohoursEnabled": true, 847 - "mileage": "", 848 - "motohours": 345.0 849 - }, 850 - "cmsv6Parameters": { ~/~/Параметры CmsV6 851 - "id": null, 852 - "enabled": true, ~/~/флаг включения 853 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 854 - "login": "", ~/~/ имя учетной записи 855 - "password": "" ~/~/ пароль учетной записи 856 - }, 857 - "inspectionTasks": { ~/~/ задания на ТО 858 - "id": "", ~/~/ ID задачи 859 - "enabled": false, ~/~/ Признак включения 860 - "name": "", ~/~/ Имя задания 861 - "description": "", ~/~/ Описание задания 862 - "mileageCondition": "", ~/~/ Условие по пробегу 863 - "lastMileage": "", ~/~/ Пробег (в метрах) 864 - "motohoursCondition": "", ~/~/ Условие по моточасам 865 - "lastMotohours": "", ~/~/ Моточасы 866 - "periodicCondition": "", ~/~/ Условие периодичности по времени 867 - "kind": "", ~/~/ Вид периодичности по времени 868 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1459 +((( 1460 +((( 1461 +((( 1462 +{ 1463 + "vehicleId": 0, ~/~/ ID ТС 1464 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1465 + "name": "string", ~/~/ Имя объекта 1466 + "imei": "string", ~/~/ IMEI 1467 + "deviceTypeId": 0, ~/~/ ID типа устройства 1468 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1469 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1470 + "sim1": "string", ~/~/ SIM1 1471 + "sim2": "string", ~/~/ SIM2 1472 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1473 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1474 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1475 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1476 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1477 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1478 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1479 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1480 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1481 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1482 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1483 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1484 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1485 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1486 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1487 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1488 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1489 + "counters": { ~/~/ Dto для состояний счётчиков 1490 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1491 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1492 + "mileage": 0, ~/~/ Пробег 1493 + "motohours": 0 ~/~/ Моточасы 1494 + }, 1495 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1496 + "id": "string", ~/~/ CMSV6 Идентификатор 1497 + "enabled": true, ~/~/ Признак включения 1498 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1499 + "login": "string", ~/~/ CMSV6 имя учетной записи 1500 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1501 + }, 1502 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1503 + { 1504 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1505 + "enabled": true, ~/~/ Признак включения 1506 + "name": "string", ~/~/ Имя задания 1507 + "description": "string", ~/~/ Описание задания 1508 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1509 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1510 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1511 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1512 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1513 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1514 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1515 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 869 869 } 1517 + ], 1518 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1519 + { 1520 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1521 + "inputNumber": 0, ~/~/ № входа. 1522 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1523 + "comment": "string", ~/~/ Комментарий 1524 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1525 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1526 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1527 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1528 + } 1529 + ], 1530 + "commandTemplates": [ ~/~/ Список шаблонов команд 1531 + { 1532 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1533 + "name": "string", ~/~/ Название шаблона команд 1534 + "command": "string", ~/~/ Команда на выполнение 1535 + "retries": 0 ~/~/ Лимит попыток отправки 1536 + } 1537 + ], 1538 + "sensors": [ ~/~/ Список датчиков 1539 + { 1540 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1541 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1542 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 1543 + "name": "string", ~/~/ Имя датчика 1544 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1545 + "inputNumber": 0, ~/~/ Номер входа 1546 + "pseudonym": "string", ~/~/ Псевдоним 1547 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1548 + "isInverted": true, ~/~/ Признак инверсии 1549 + "disabled": true, ~/~/ Датчик не участвует в обработке 1550 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1551 + "gradesTables": [ ~/~/ Тарировка 1552 + { 1553 + "grades": [ ~/~/ Таблицы тарировки 1554 + { 1555 + "input": 0, ~/~/ Вход 1556 + "output": 0 ~/~/ Выход 1557 + } 1558 + ], 1559 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1560 + } 1561 + ], 1562 + "showInTooltip": true, ~/~/ Отображение в подсказке 1563 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1564 + "color": "string", ~/~/ код цвета датчиков 1565 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1566 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1567 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1568 + "expr": "string", ~/~/ Выражение 1569 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1570 + "string" 1571 + ], 1572 + "customParams": { 1573 + "additionalProp1": "string", 1574 + "additionalProp2": "string", 1575 + "additionalProp3": "string" 1576 + }, 1577 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1578 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1579 + { 1580 + "from": 0, ~/~/ С какого значения 1581 + "color": "string", ~/~/ Каким цветом 1582 +))) 870 870 871 -(% style="text-align:left" %) 872 -(% style="color:#000000" %)} 1584 +((( 1585 + "text": "string" ~/~/ Текст подписи к этому интервалу 1586 + } 1587 + ] 1588 + } 1589 + ], 1590 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1591 + "customFields": [ ~/~/ Список произвольных полей 1592 + { 1593 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1594 + "name": "string", ~/~/ Наименование произвольного поля 1595 + "value": "string", ~/~/ Значение произвольного поля 1596 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1597 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1598 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1599 + } 1600 + ], 1601 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1602 +} 1603 +))) 1604 +))) 1605 +))) 873 873 1607 + 874 874 **Валидация:** 875 875 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 876 876 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 877 877 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 878 878 879 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 880 880 1614 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1615 + 881 881 (% class="box infomessage" %) 882 882 ((( 883 883 (% lang="en-US" %)**POST /api/v3/vehicles/find** 884 884 ))) 885 885 886 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1621 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 887 887 888 888 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 889 889 ... ... @@ -917,9 +917,12 @@ 917 917 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 918 918 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 919 919 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 920 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 921 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 922 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1655 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1656 + "unitName": "string", ~/~/ Название подразделения (опционально) 1657 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1658 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1659 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1660 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 923 923 } 924 924 925 925 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -926,8 +926,14 @@ 926 926 927 927 (% style="color:#000000" %)Ответ: 928 928 929 -(% style="color:#000000" %){ 1667 +(% style="color:#000000" %)[ 1668 +{ 930 930 1670 +((( 1671 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1672 +))) 1673 + 1674 +((( 931 931 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 932 932 "name": "" ~/~/ наименование объекта 933 933 "imei": "" ~/~/ IMEI объекта ... ... @@ -953,9 +953,21 @@ 953 953 "forClient": true, ~/~/ право на отображение у клиента 954 954 "forTooltip": false, ~/~/ право на отображение в подсказке 955 955 "forReport": false ~/~/ право на отображение в отчетах 956 - }(%%) 957 -(% style="color:#000000" %)} 1700 +))) 958 958 1702 +((( 1703 + } 1704 + ], 1705 + "vehicleGroups": [ ~/~/ Группы ТС 1706 + { 1707 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1708 + "name": "string" ~/~/ Наименование группы ТС 1709 + } 1710 + ] 1711 + } 1712 +] 1713 +))) 1714 + 959 959 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 960 960 961 961 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -987,13 +987,11 @@ 987 987 "data": "", ~/~/ Данные 988 988 "overwrite": false, ~/~/ Флаг перезаписи 989 989 "stage": "", ~/~/ Состояние, может быть null 990 - 991 991 (% style="color:#000000" %)} 992 992 993 993 (% style="color:#000000" %)Ответ: 994 994 995 -(% style="color:#000000" %){ 996 - 1750 +(% style="color:#000000" %){(%%) 997 997 "status": "", ~/~/ значение статуса 998 998 "date": "", ~/~/ Дата смены статуса 999 999 "description": "", ~/~/ Описание ... ... @@ -1000,10 +1000,9 @@ 1000 1000 "data": "", ~/~/ Данные 1001 1001 "overwrite": false, ~/~/ Флаг перезаписи 1002 1002 "stage": "", ~/~/ Состояние 1003 - 1004 -(% style="text-align:left" %) 1005 1005 (% style="color:#000000" %) } 1006 1006 1759 + 1007 1007 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1008 1008 1009 1009 (% class="box warningmessage" %) ... ... @@ -1011,7 +1011,7 @@ 1011 1011 (% lang="en-US" %)**PUT /api/v3/vehicles** 1012 1012 ))) 1013 1013 1014 -(% style="color:#000000" %)Метод позволяет отредактировать объект . Метод позволяет отредактировать объект, указанный в запросе.1767 +(% style="color:#000000" %)Метод позволяет отредактировать объект, указанный в запросе. 1015 1015 1016 1016 (% style="color:#000000" %)Метод запроса: **PUT** 1017 1017 ... ... @@ -1021,18 +1021,16 @@ 1021 1021 1022 1022 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1023 1023 1024 -(% style="color:#000000" %){ 1025 - 1026 -((( 1027 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1028 - "parentId": "", ~/~/ ID клиента 1029 - "name": "", ~/~/ имя ТС 1030 - "imei": "", ~/~/ IMEI 1031 - "deviceTypeId": "", ~/~/ ID типа устройства 1032 - "modelId": "", ~/~/ , ID модели 1033 - "unitId": "", ~/~/ подразделения 1034 - "sim1": "", ~/~/ SIM 1 1035 - "sim2": "", ~/~/ SIM2 (%%) 1777 +(% style="color:#000000" %){ 1778 + "vehicleId": , ~/~/ ID объекта 1779 + "parentId": "" , ~/~/ ID клиента 1780 + "name": "" , ~/~/ имя ТС 1781 + "imei": "" , ~/~/ IMEI 1782 + "deviceTypeId": "" , ~/~/ ID типа устройства 1783 + "modelId": "" , ~/~/ ID модели 1784 + "unitId": "" , ~/~/ ID подразделения 1785 + "sim1": "" , ~/~/ Номер SIM 1 1786 + "sim2": "" , ~/~/ Номер SIM2 1036 1036 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1037 1037 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1038 1038 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1045,89 +1045,326 @@ 1045 1045 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1046 1046 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1047 1047 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1048 -(% style="color:#000000" %) "counters": 1049 - { 1050 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1051 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1052 - "mileage": "", ~/~/ пробег, в метрах 1053 - "motohours": "" ~/~/ моточасы, в секундах 1054 - } 1055 - "cmsv6Parameters": ~/~/ параметры CMSv6 1056 - { 1057 - "id": "", ~/~/ идентификатор 1058 - "enabled": true, ~/~/ флаг включения 1059 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1060 - "login": "", ~/~/ имя учетной записи 1061 - "password": "", ~/~/ пароль учетной записи 1062 - } 1063 - "inspectionTasks": ~/~/ задания на ТО 1064 - { 1065 - "id": "", ~/~/ ID задания 1066 - "enabled": false, ~/~/ Признак включения 1067 - "name": "", ~/~/ Имя задания 1068 - "description": "", ~/~/ Описание задания 1069 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1070 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1071 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1072 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1073 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1074 - "kind": "", ~/~/ Вид периодичности по времени 1075 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1076 - } 1799 + 1800 + "mileageCalcMethod": 0, 1801 + "mileageCoeff": 0, 1802 + "locationByCellId": true, 1803 + "dottedLineTrackWhenNoCoords": true, 1804 + "counters": ~/~/ счетчики 1805 + { 1806 + "mileage": "" , ~/~/ пробег 1807 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1808 + "motohours": "" , ~/~/ моточасы 1809 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1810 + }, 1811 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1812 + "enabled": true, ~/~/ флаг включения 1813 + "id": "" , ~/~/ идентификатор 1814 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1815 + "login": "" , ~/~/ имя учетной записи 1816 + "password": "" ~/~/ пароль учетной записи 1817 + }, 1818 + "inspectionTasks": ~/~/ задания на ТО 1819 + { 1820 + "enabled": "" , ~/~/ Признак включения 1821 + "name": "" , ~/~/ Имя задания 1822 + "description": "" , ~/~/ Описание задания 1823 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1824 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1825 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1826 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1827 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1828 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1829 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1830 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1831 + } 1832 + 1833 +"drivers": [ ~/~/ Водители 1834 + { 1835 + 1836 +((( 1837 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1838 + "inputNumber": 0, ~/~/ № входа. 1839 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1840 + "comment": "string", ~/~/ Комментарий. 1841 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1842 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1843 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1844 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1077 1077 ))) 1078 1078 1079 -(% style="color:#000000" %)} 1847 + } 1848 + ], 1849 + "commandTemplates": [ ~/~/ Шаблон команды 1850 + { 1851 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1852 + "name": "string", 1853 + "command": "string", 1854 + "retries": 0 1855 + } 1856 + ], 1857 +"sensors": [ ~/~/ Датчики 1858 + { 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1860 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1861 + "type": 0, ~/~/ Тип датчика 1862 + "name": "string", ~/~/ Имя датчика 1863 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1864 + "inputNumber": 0, ~/~/ Номер входа 1865 + "pseudonym": "string", ~/~/ Псевдоним 1866 + "medianDegree": 0, ~/~/ Медианная фильтрация 1867 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1868 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1869 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1870 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1871 + { 1872 + "grades": [ ~/~/ Таблица тарировки 1 1873 + { 1874 + "input": 0, ~/~/ Входящее значение 1875 + "output": 0 ~/~/ Выходящее значение 1876 + } 1877 + ], 1878 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1879 + } 1880 + ], 1881 + "showInTooltip": true, ~/~/ Отображать в подсказке 1882 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1080 1080 1884 +((( 1885 + "color": "string",** ~/~/ **Цвет датчика 1886 +))) 1887 + 1888 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1889 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1890 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1891 + "expr": "string", ~/~/ Формула 1892 + "children": [ ~/~/ массив дочерних датчиков 1893 + "string" 1894 + ], 1895 + "customParams": { ~/~/ прочие произвольные параметры 1896 + "additionalProp1": "string", 1897 + "additionalProp2": "string", 1898 + "additionalProp3": "string" 1899 + }, 1900 +~/~/ Характерные для произвольного: 1901 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1902 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1903 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1904 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1905 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1906 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1907 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1908 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1909 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1910 +~/~/ "ValueOn": "Вкл.", 1911 +~/~/ "ValueOff": "Выкл." 1912 + "summaryMaxValue": 0 ~/~/ Макс. значение 1913 + 1914 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1915 + { 1916 + "from": 0, ~/~/ С какого значения 1917 + "color": "string", ~/~/ Каким цветом 1918 + "text": "string" ~/~/ Текст подписи к этому интервалу 1919 + } 1920 + ] 1921 + } 1922 + ], 1923 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1924 + 1925 + "customFields": [ ~/~/ Произвольные поля 1926 + { 1927 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1928 + "name": "string", ~/~/ Наименование произвольного поля 1929 + "value": "string", ~/~/ Значение произвольного поля 1930 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1931 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1932 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1933 + } 1934 + 1935 +((( 1936 + ], 1937 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1938 +))) 1939 + 1940 +} 1941 + 1942 + 1081 1081 (% style="color:#000000" %)Ответ: 1082 1082 1083 -(% lang="en-US" style="text-align:left" %) 1084 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1945 +((( 1946 +{ 1947 + "vehicleId": 0, ~/~/ ID ТС 1948 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1949 + "name": "string", ~/~/ Имя объекта 1950 + "imei": "string", ~/~/ IMEI 1951 + "deviceTypeId": 0, ~/~/ ID типа устройства 1952 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1953 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1954 + "sim1": "string", ~/~/ SIM1 1955 + "sim2": "string", ~/~/ SIM2 1956 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1957 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1958 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1959 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1960 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1961 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1962 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1963 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1964 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1965 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1966 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1967 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1968 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1969 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1970 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1971 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1972 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1973 + "counters": { ~/~/ состояний счётчиков 1974 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1975 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1976 + "mileage": 0, ~/~/ Пробег 1977 + "motohours": 0 ~/~/ Моточасы 1978 + }, 1979 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1980 + "id": "string", ~/~/ CMSV6 Идентификатор 1981 + "enabled": true, ~/~/ Признак включения 1982 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 1983 +))) 1085 1085 1086 -(% lang="en-US" style="text-align:left" %) 1087 - "vehicleId": "", ~/~/ ID ТС 1088 - "parentId": "", ~/~/ ID клиента 1089 - "name": "", ~/~/ имя ТС 1090 - "imei": "", ~/~/ IMEI 1091 - "deviceTypeId": "", ~/~/ типа устройства 1092 - "modelId": "", ~/~/ ID модели 1093 - "unitId": "", ~/~/ ID подразделения 1094 - "sim1": "", ~/~/ SIM 1 1095 - "sim2": "", ~/~/ SIM2 1096 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1097 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1098 - "counters": 1099 - { 1100 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1101 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1102 - "mileage": "", ~/~/ пробег 1103 - "motohours": "", ~/~/ моточасы 1104 - } 1105 - "cmsv6Parameters": ~/~/ параметры CMSv6 1985 + 1986 +((( 1987 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1988 + "login": "string", ~/~/ CMSV6 имя учетной записи 1989 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1990 + }, 1991 + "inspectionTasks": [ ~/~/ Задания на ТО 1992 + { 1993 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1994 + "enabled": true, ~/~/ Признак включения 1995 + "name": "string", ~/~/ Имя задания 1996 + "description": "string", ~/~/ Описание задания 1997 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1998 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1999 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2000 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2001 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2002 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2003 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2004 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2005 + } 2006 + ], 2007 + "drivers": [ ~/~/ Список водителей 2008 + { 2009 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2010 + "inputNumber": 0, ~/~/ № входа. 2011 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2012 + "comment": "string", ~/~/ Комментарий. 2013 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2014 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2015 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2016 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2017 + } 2018 + ], 2019 + "commandTemplates": [ ~/~/ Список шаблонов команд 2020 + { 2021 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2022 + "name": "string", ~/~/ Название шаблона команд 2023 + "command": "string", ~/~/ Команда на выполнение 2024 + "retries": 0 ~/~/ Лимит попыток отправки 2025 + } 2026 + ], 2027 + "sensors": [ ~/~/ Список датчиков 2028 + { 2029 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2030 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2031 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2032 +))) 2033 + 2034 +((( 2035 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2036 +))) 2037 + 2038 +((( 2039 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2040 +))) 2041 + 2042 +((( 2043 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2044 +))) 2045 + 2046 +((( 2047 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2048 +))) 2049 + 2050 +((( 2051 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2052 + "name": "string", ~/~/ Имя датчика 2053 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2058 + "inputNumber": 0, ~/~/ Номер входа 2059 + "pseudonym": "string", ~/~/ Псевдоним 2060 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2061 + "isInverted": true, ~/~/ Признак инверсии 2062 + "disabled": true, ~/~/ Датчик не участвует в обработке 2063 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2064 + "gradesTables": [ ~/~/ Тарировка 1106 1106 { 1107 - "id": ~/~/ идентификатор 1108 - "enabled": true, ~/~/ флаг включения 1109 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1110 - "login": "", ~/~/ имя учетной записи 1111 - "password": "", ~/~/ пароль учетной записи 1112 - } 1113 - "inspectionTasks": ~/~/ задания на ТО 1114 - { 1115 - "id": "", ~/~/ ID задания 1116 - "enabled": false, ~/~/ Признак включения 1117 - "name": "", ~/~/ Имя задания 1118 - "description": "", ~/~/ Описание задания 1119 - "mileageCondition": "", ~/~/ Условие по пробегу 1120 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1121 - "motohoursCondition": "", ~/~/ Условие по моточасам 1122 - "lastMotohours": "", ~/~/ Моточасы 1123 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1124 - "kind": "", ~/~/ Вид периодичности по времени 1125 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2066 + "grades": [ ~/~/ Таблицы тарировки 2067 + { 2068 + "input": 0, ~/~/ Вход 2069 + "output": 0 ~/~/ Выход 2070 + } 2071 + ], 2072 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1126 1126 } 2074 + ], 2075 + "showInTooltip": true, ~/~/ Отображение в подсказке 2076 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1127 1127 1128 -(% lang="en-US" style="text-align:left" %) 1129 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2078 +((( 2079 + "color": "string", ~/~/ цвет уведомлений 2080 +))) 1130 1130 2082 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2083 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2084 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2085 + "expr": "string", ~/~/ Выражение 2086 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2087 + "string" 2088 + ], 2089 + "customParams": { ~/~/ Дополнительные настройки 2090 + "additionalProp1": "string", 2091 + "additionalProp2": "string", 2092 + "additionalProp3": "string" 2093 + }, 2094 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2095 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2096 + { 2097 + "from": 0, ~/~/ С какого значения 2098 + "color": "string", ~/~/ Каким цветом 2099 + "text": "string" ~/~/ Текст подписи к этому интервалу 2100 + } 2101 + ] 2102 + } 2103 + ], 2104 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2105 + "customFields": [ ~/~/ Список произвольных полей 2106 + { 2107 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2108 + "name": "string", ~/~/ Наименование произвольного поля 2109 + "value": "string", ~/~/ Значение произвольного поля 2110 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2111 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2112 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2113 + } 2114 + ], 2115 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2116 +} 2117 +))) 2118 + 1131 1131 **Валидация:** 1132 1132 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1133 1133 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1140,7 +1140,7 @@ 1140 1140 (% lang="en-US" %)**DELETE /api/v3/vehicles/{vehicleId}** 1141 1141 ))) 1142 1142 1143 -(% style="color:#000000" %)Метод позволяет удалить объект . Метод позволяет удалить объект, указанный в строке запроса.2131 +(% style="color:#000000" %)Метод позволяет удалить объект, указанный в строке запроса. 1144 1144 1145 1145 (% style="color:#000000" %)Метод запроса: **DELETE** 1146 1146 ... ... @@ -1166,18 +1166,15 @@ 1166 1166 1167 1167 (% style="color:#000000" %)Метод запроса: **GET** 1168 1168 1169 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2157 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1170 1170 1171 1171 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1172 1172 1173 1173 (% style="color:#000000" %)Ответ: 1174 1174 1175 -(% style="color:#000000" %){ 1176 - 2163 +(% style="color:#000000" %){(%%) 1177 1177 "deviceTypeId" : "", ~/~/ ID типа устройства 1178 1178 "deviceTypeName" : "" ~/~/ Название типа устройства 1179 - 1180 -(% style="text-align:left" %) 1181 1181 (% style="color:#000000" %)} 1182 1182 1183 1183 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1199,13 +1199,10 @@ 1199 1199 1200 1200 (% style="color:#000000" %)Ответ: 1201 1201 1202 -(% style="color:#000000" %){ 1203 - 2187 +(% style="color:#000000" %){(%%) 1204 1204 "id": "", ~/~/ ID типа датчика 1205 1205 "name": "", ~/~/ Название 1206 1206 "description": "", ~/~/ Описание 1207 - 1208 -(% style="text-align:left" %) 1209 1209 (% style="color:#000000" %)} 1210 1210 1211 1211 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1249,6 +1249,56 @@ 1249 1249 } 1250 1250 ] 1251 1251 2234 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2235 + 2236 +(% class="box infomessage" style="text-align: left;" %) 2237 +((( 2238 +**POST /api/v3/terminalMessages/mapping** 2239 +))) 2240 + 2241 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2242 + 2243 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2244 + 2245 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2246 + 2247 +{ 2248 + "protocolType": 0, 2249 + "params": ["string"] 2250 +} 2251 + 2252 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2253 +|protocolType|ID типа протокола 2254 +|params|((( 2255 +Массив наименований параметров в сообщении 2256 +))) 2257 + 2258 +Ответ: 2259 + 2260 +{ 2261 + "protocolType": 0, 2262 + "mapping": { 2263 + "additionalProp1": { 2264 + "inputType": 0, 2265 + "inputNumber": 0 2266 + }, 2267 + "additionalProp2": { 2268 + "inputType": 0, 2269 + "inputNumber": 0 2270 + } 2271 + } 2272 +} 2273 + 2274 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2275 +|protocolType|Тип протокола 2276 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2277 +|inputNumber|((( 2278 +Номер входа 2279 +))) 2280 + 2281 +(% class="wikigeneratedid" %) 2282 +Перечень ID протоколов в статье - [[ID протоколов для получения типов и номеров входа сырого параметра.>>https://wiki.glonasssoft.ru/bin/view/API/ID%20%D0%BF%D1%80%D0%BE%D1%82%D0%BE%D0%BA%D0%BE%D0%BB%D1%8B%20%D0%B4%D0%BB%D1%8F%20%D0%BF%D0%BE%D0%BB%D1%83%D1%87%D0%B5%D0%BD%D0%B8%D1%8F%20%D1%82%D0%B8%D0%BF%D0%B0%20%D0%B8%20%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D0%B0%20%D0%B2%D1%85%D0%BE%D0%B4%D0%B0%20%D1%81%D1%8B%D1%80%D0%BE%D0%B3%D0%BE%20%D0%BF%D0%B0%D1%80%D0%B0%D0%BC%D0%B5%D1%82%D1%80%D0%B0/]] 2283 + 1252 1252 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1253 1253 1254 1254 (% class="box infomessage" %) ... ... @@ -1273,6 +1273,11 @@ 1273 1273 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1274 1274 } 1275 1275 2308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2309 +|vehicleId|ID объекта 2310 +|from|Дата и время начала периода запроса 2311 +|to|Дата и время окончания периода запроса 2312 + 1276 1276 Ответ: 1277 1277 1278 1278 [ ... ... @@ -1279,30 +1279,322 @@ 1279 1279 { 1280 1280 "messages": [ 1281 1281 { 1282 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1283 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1284 - "speed": 0, ~/~/ Скорость, км/ч 1285 - "altitude": 0, ~/~/ Высота, м 1286 - "latitude": 0, ~/~/ Широта [-90°;90°] 1287 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1288 - "satellites": 0, ~/~/ Кол-во спутников 1289 - "voltage": 0, ~/~/ Напряжение 1290 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2319 + "deviceTime": "2023-11-29T07:40:44.052Z", 2320 + "serverTime": "2023-11-29T07:40:44.052Z", 2321 + "speed": 0, 2322 + "altitude": 0, 2323 + "latitude": 0, 2324 + "longitude": 0, 2325 + "satellites": 0, 2326 + "course": 0, 2327 + "voltage": 0, 2328 + "parameters": { 1291 1291 "additionalProp1": "string", 1292 1292 "additionalProp2": "string", 1293 1293 "additionalProp3": "string" 1294 1294 }, 1295 - "photoCount": 0 ~/~/ Кол-во фото 2333 + "photoCount": 0, 2334 + "lbsCorrectedCoords": true, 2335 + "protocolType": 0 1296 1296 } 1297 1297 ] 1298 1298 } 1299 1299 ] 1300 1300 2341 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2342 +|deviceTime|Время сообщения терминала 2343 +|serverTime|Время когда сообщение поступило на сервер 2344 +|speed|Скорость 2345 +|altitude|Высота над уровнем моря 2346 +|latitude|Широта 2347 +|longitude|Долгота 2348 +|satellites|Кол-во спутников 2349 +|course|Курс 2350 +|voltage|Бортовое напряжение 2351 +|parameters|Список параметров и их значений 2352 +|photoCount|Количество фото 2353 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2354 +|protocolType|ID типа протокола 2355 + 2356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2357 + 2358 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2359 + 2360 +(% class="box infomessage" %) 2361 +((( 2362 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2363 +))) 2364 + 2365 +(% style="color:#000000" %)Метод запроса: **POST** 2366 + 2367 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2368 + 2369 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2370 + 2371 +(% style="text-align:left" %) 2372 +Тело запроса: 2373 + 2374 +{ 2375 + "sampling": 86400, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2376 + "vehicleIds": [0], ~/~/ Список ID объектов 2377 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2378 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2379 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2380 +} 2381 + 2382 +Ответ: 2383 + 2384 +[ 2385 + { 2386 + "vehicleId": 0, ~/~/ ID объекта 2387 + "name": "string", ~/~/ Имя ТС 2388 + "periods": [ ~/~/ Периоды 2389 + { 2390 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2391 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2392 + "mileage": 0, ~/~/ Пробег за период, километры 2393 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2394 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2395 + "motohours": 0, ~/~/ Моточасы за период, секунды 2396 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2397 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2398 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2399 + 2400 + } 2401 + ] 2402 + } 2403 +] 2404 + 2405 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2406 + 2407 +(% class="box infomessage" %) 2408 +((( 2409 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2410 +))) 2411 + 2412 +(% style="color:#000000" %)Метод запроса: **POST** 2413 + 2414 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2415 + 2416 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2417 + 2418 +(% style="text-align:left" %) 2419 +Тело запроса: 2420 + 2421 +{ 2422 + "vehicleIds": [0], ~/~/ Список ID объектов 2423 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2424 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2425 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2426 +} 2427 + 2428 +Ответ: 2429 + 2430 +[ 2431 + { 2432 + "vehicleId": 0, ~/~/ ID объекта 2433 + "name": "string", ~/~/ Имя ТС 2434 + "periods": [ ~/~/ Периоды 2435 + { 2436 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2437 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2438 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2439 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2440 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2441 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2442 + "fuelConsumption": 0, ~/~/ Расход топлива 2443 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2444 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2445 + 2446 + } 2447 + ] 2448 + } 2449 +] 2450 + 2451 +(% class="box warningmessage" %) 2452 +((( 2453 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2454 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2455 +))) 2456 + 2457 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2458 + 2459 +(% class="box infomessage" %) 2460 +((( 2461 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2462 +))) 2463 + 2464 +(% style="color:#000000" %)Метод запроса: **POST** 2465 + 2466 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2467 + 2468 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2469 + 2470 +(% style="text-align:left" %) 2471 +Тело запроса: 2472 + 2473 +{ 2474 + "vehicleIds": [0], ~/~/ Список ID объектов 2475 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2476 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2477 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2478 +} 2479 + 2480 +Ответ: 2481 + 2482 +[ 2483 + { 2484 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2485 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2486 + "vehicleId": 0, ~/~/ ID объекта 2487 + "name": "string", ~/~/ Имя объекта 2488 + "model": "string", ~/~/ Модель объекта 2489 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2490 + { 2491 + "event": 0, ~/~/ Тип события 0 - Other, 1 - Engine, 2 - Stop, 3 - FuelIn, 4 - FuelOut, 5 - Garbage, 6 - Grader, 8 - Otval, 9 - Sand, 10 - MixerLand, 11 - MixerMove, 12 - OpenCircuit, 13 - TechSpeed, 14 - Work, 15 - Braid, 16 - Broom, 17 - ReFuller, 18 - Crane, 19 - Power, 20 - TankFuelIn, 21 - TankFuelOut, 22 - BigStop, 23 - OverSpeed, 24 - Unloading, 25 - Warning, 26 - GarbageWork, 27 - Custom, 28 - CustomWork, 29 - GNSS, 30 - GrainIn, 31 - GrainOut, 32 - WeighingTerminal, 33 - Stopping, 34 - FertilizerWork, 35 - FertilizerRefueling 2492 + 2493 +((( 2494 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2495 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2496 + "valueFuel": 0, ~/~/ Количество 2497 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2498 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2499 +))) 2500 + 2501 +((( 2502 + "latitude": 0, ~/~/ Широта. 2503 + "longitude": 0 ~/~/ Долгота. 2504 +))) 2505 + 2506 + } 2507 + ] 2508 + } 2509 +] 2510 + 2511 + 2512 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2513 + 2514 +(% class="box infomessage" %) 2515 +((( 2516 +**POST /api/v3/vehicles/moveStop** 2517 +))) 2518 + 2519 +Метод запроса: **POST** 2520 + 2521 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2522 + 2523 +В заголовках запроса: X-Auth: Токен авторизации 2524 + 2525 + 2526 +Тело запроса: 2527 + 2528 +{ 2529 + "vehicleIds": [ ], ~/~/ Список ID объектов 2530 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2531 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2532 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2533 +} 2534 + 2535 +Ответ: 2536 + 2537 +[ 2538 + { 2539 + "vehicleId": 0, ~/~/ ID объекта 2540 + "vehicleName": "string", ~/~/ Имя объекта 2541 + "moves": [ ~/~/ Событие движения 2542 + { 2543 + "mileage": 0, ~/~/ Пробег, км 2544 + "eventId": 0, ~/~/ Идентификатор события 2545 + "eventName": "string", ~/~/ Название события 2546 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2547 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2548 + "duration": 0 ~/~/ Продолжительность события, секунд 2549 + } 2550 + ], 2551 + "stops": [ ~/~/ События стоянок 2552 + { 2553 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2554 + "eventId": 0, ~/~/ Идентификатор события 2555 + "eventName": "string", ~/~/ Название события 2556 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2557 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2558 + "duration": 0 ~/~/ Продолжительность события, секунд 2559 + } 2560 + ] 2561 + } 2562 +] 2563 + 2564 + 2565 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2566 + 2567 +(% class="box infomessage" %) 2568 +((( 2569 +**POST /api/v3/vehicles/getlastdata** 2570 +))) 2571 + 2572 +Метод запроса: **POST** 2573 + 2574 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2575 + 2576 +В заголовках запроса: X-Auth: Токен авторизации 2577 + 2578 + 2579 +В массиве указываем id объектов через запятую 2580 + 2581 +Ответ: 2582 + 2583 +[ 2584 + { 2585 + "vehicleId": 55728, ~/~/ Идентификатор объекта 2586 + "vehicleGuid": "fa9c0357-9b9f-44b9-a89c-20a2cb80a9ad", ~/~/ Guid объекта 2587 + "vehicleNumber": "0105 КМ", ~/~/ Номер объекта 2588 + "receiveTime": "2025-06-27T12:37:46.7782735Z", ~/~/ Время и дата поступления данных 2589 + "recordTime": "2025-06-27T12:37:19Z", ~/~/ Время и дата формирование данных 2590 + "state": 4, ~/~/ Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2591 + "speed": 31, ~/~/ Скорость объекта 2592 + "course": 116, ~/~/ Курс движения [0;360] 2593 + "latitude": 45.722128, ~/~/ Широта [-90°;90°]. 2594 + "longitude": 39.800432, ~/~/ Долгота [-180°;180°]. 2595 + "address": "\" Краснодарский край Россия 45,722128°, 39,800432°\"", ~/~/ Адрес 2596 + "geozones": [ ~/~/ Сведения по геозонам. 2597 + { 2598 + "id": 10225647, ~/~/ ID Геозоны 2599 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2600 + }, 2601 + { 2602 + "id": 10282875, ~/~/ ID Геозоны 2603 + "name": "Ё2" ~/~/ Наименование геозоны 2604 + }, 2605 + { 2606 + "id": 10226240, ~/~/ ID Геозоны 2607 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2608 + }, 2609 + { 2610 + "id": 9747869, ~/~/ ID Геозоны 2611 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2612 + }, 2613 + { 2614 + "id": 10221123, ~/~/ ID Геозоны 2615 + "name": "53r" ~/~/ Наименование геозоны 2616 + }, 2617 + { 2618 + "id": 10197638, ~/~/ ID Геозоны 2619 + "name": "Предприятие \"Газырское\" Участок №7/Поле 7-11/1" ~/~/ Наименование геозоны 2620 + } 2621 + ] 2622 + } 2623 + 2624 + 2625 += = 2626 + 1301 1301 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1302 1302 1303 1303 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == 1304 1304 1305 -POST /api/v3/notifications/find 2631 +(% class="box infomessage" %) 2632 +((( 2633 +**POST /api/v3/notifications/find** 2634 +))) 1306 1306 1307 1307 Метод возвращает информацию об уведомлениях переданного клиента и его клиентов ниже по иерархии. 1308 1308 ... ... @@ -1323,21 +1323,172 @@ 1323 1323 1324 1324 [ 1325 1325 { 1326 - "id": 0, 1327 - "name": "string", 1328 - "active": true, 1329 - "type": 0, 1330 - "userId": "", 1331 - "parentId": "", 1332 - "parentName": "string" 2655 + "id": 0, ~/~/ ID уведомления 2656 + "name": "string", ~/~/ Название уведомления 2657 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2658 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 2659 + "userId": "", ~/~/ Пользователь, создавший уведомление 2660 + "parentId": "", ~/~/ Идентификатор клиента 2661 + "parentName": "string" ~/~/ Имя клиента 1333 1333 } 1334 1334 ] 1335 1335 1336 1336 1337 - Запроснастроекуведомления2666 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 1338 1338 1339 -GET /api/v3/notifications/{id} 2668 +(% class="box infomessage" %) 2669 +((( 2670 +**POST /api/v3/notifications** 2671 +))) 1340 1340 2673 +Метод запроса **POST** 2674 + 2675 +(% style="text-align: left;" %) 2676 +(% style="color:#000000" %)Пример запроса 2677 + 2678 +((( 2679 +{ 2680 + "id": 0, ~/~/ ID правила 2681 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2682 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2683 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2684 + "name": "string", ~/~/ Имя правила 2685 + "active": true, ~/~/ Активность правила 2686 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2687 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2688 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2689 + ], 2690 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2691 + 0 2692 + ], 2693 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2694 + 0 2695 + ], 2696 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2697 + 0 2698 + ], 2699 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2700 + "additionalProp1": "string", 2701 + "additionalProp2": "string", 2702 + "additionalProp3": "string" 2703 + }, 2704 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2705 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2706 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2707 + ], 2708 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2709 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2710 + "string" 2711 + ], 2712 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2713 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2714 + { 2715 + "id": 0, ~/~/ Идентификатор участника чата. 2716 + "info": "string" ~/~/ Дополнительные сведения. 2717 + } 2718 + ], 2719 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2720 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2721 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2722 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2723 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2724 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2725 + "timezone": 0, ~/~/ часовой пояс 2726 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2727 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2728 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2729 + { 2730 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2731 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2732 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2733 + "additionalProp1": "string", 2734 + "additionalProp2": "string", 2735 + "additionalProp3": "string" 2736 + } 2737 + } 2738 + ] 2739 +} 2740 +))) 2741 + 2742 +((( 2743 + 2744 +))) 2745 + 2746 +((( 2747 + 2748 +))) 2749 + 2750 +Ответ: 2751 + 2752 +{ 2753 + "id": 0, ~/~/ ID правила 2754 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2755 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2756 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2757 + "name": "string", ~/~/ Имя правила 2758 + "active": true, ~/~/ Активность правила 2759 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2760 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2761 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2762 + ], 2763 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2764 + 0 2765 + ], 2766 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2767 + 0 2768 + ], 2769 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2770 + 0 2771 + ], 2772 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2773 + "additionalProp1": "string", 2774 + "additionalProp2": "string", 2775 + "additionalProp3": "string" 2776 + }, 2777 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2778 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2779 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2780 + ], 2781 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2782 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2783 + "string" 2784 + ], 2785 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2786 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2787 + { 2788 + "id": 0, ~/~/ Идентификатор участника чата. 2789 + "info": "string" ~/~/ Дополнительные сведения. 2790 + } 2791 + ], 2792 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2793 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2794 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2795 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2796 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2797 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2798 + "timezone": 0, ~/~/ часовой пояс 2799 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2800 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2801 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2802 + { 2803 + "type": 0, ~/~/ 0 - Нет, 1 - Превышение скорости, 2 - Вход в геозону, 3 - выход из геозоны, 4 - Паническая активация, 5 - Дискретный датчик, 6 - Отключение дискретного датчика, 7 - Работа аналогового датчика, 8 - Отсутствуют данные, 9 - Отсутствуют координаты, 10 - Бездействие, 11 - Адрес объекта, 12 - Заканчивается топливо, 13 - Заправка, 14 - Превышение скорости, 15 - Превышение скорости, 16 - Превышение нормы, 17 - Возврат к бездействию, 18 - Адрес объекта, 19 - Отсутствуют данные, 20 - отсутствуют координаты, 21 - Запланировано техническое обслуживание автомобиля, 22 - Требуется техническое обслуживание автомобиля, 23 - Техническое обслуживание автомобиля завершено, 24 - Открыто назначение водителя, 25 - Закрыто назначение водителя, 255 - Срок действия правила истек 2804 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2805 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2806 + "additionalProp1": "string", 2807 + "additionalProp2": "string", 2808 + "additionalProp3": "string" 2809 + } 2810 + } 2811 + ] 2812 +} 2813 + 2814 +== (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 2815 + 2816 +(% class="box infomessage" %) 2817 +((( 2818 +**GET /api/v3/notifications/{id}** 2819 +))) 2820 + 1341 1341 Метод возвращает данные правил формирования выбранного уведомления. 1342 1342 1343 1343 (% style="text-align: left;" %) ... ... @@ -1344,7 +1344,7 @@ 1344 1344 Метод запроса **GET** 1345 1345 1346 1346 (% style="text-align: left;" %) 1347 -(% style="color:#000000" %)URL запроса: (%%) [[https:~~/~~/hosting.glonasssoft.ru/api/v3/notifications/find{id}>>https://hosting.glonasssoft.ru/api/v3/notifications/find{id}]]2827 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 1348 1348 1349 1349 (% style="text-align: left;" %) 1350 1350 (% style="color:#000000" %)Параметр запроса: {**__id__**} - (%%)id уведомления ... ... @@ -1357,54 +1357,3715 @@ 1357 1357 1358 1358 (% style="text-align: left;" %) 1359 1359 (% style="color:#000000" %){ 1360 - "id": 0, 1361 - "type": 0, 1362 - "userId": "", 1363 - "parentId": "", 1364 - "parentName": "string", 1365 - "name": "string", 1366 - "active": true, 1367 - "vehicleIds": [ 2840 + "id": 0, ~/~/ (%%)id уведомления 2841 +(% style="color:#000000" %) "type": 0, (%%)~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2842 +(% style="color:#000000" %) "userId": "", /(%%)/ Пользователь, создавший уведомление 2843 +(% style="color:#000000" %) "parentId": "", (%%)~/~/ Идентификатор клиента 2844 +(% style="color:#000000" %) "parentName": "string", (%%)~/~/ Имя клиента 2845 +(% style="color:#000000" %) "name": "string", (%%)~/~/ Название уведомления 2846 +(% style="color:#000000" %) "active": true, (%%)~/~/ Состояние true - активен, false - деактивирован 2847 +(% style="color:#000000" %) "vehicleIds": [ ~/~/ (%%)Список id объектов для анализа 2848 +(% style="color:#000000" %) 0 2849 + ], 2850 + "geoids": [ ~/~/ (%%)Список id геообъектов для анализа 2851 +(% style="color:#000000" %) 0 2852 + ], 2853 + "fieldids": [ ~/~/ (%%)Список id полей для анализа 2854 +(% style="color:#000000" %) 0 2855 + ], 2856 + "settings": { ~/~/ Список параметров уведомления 2857 + "additionalProp1": "string", 2858 + "additionalProp2": "string", 2859 + "additionalProp3": "string" 2860 + }, 2861 + "toEmail": true, ~/~/ (%%)Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2862 +(% style="color:#000000" %) "recipientIds": [ ~/~/ (%%)Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2863 +(% style="color:#000000" %) "" 2864 + ], 2865 + "enableSideEmails": true, ~/~/ (%%)Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2866 +(% style="color:#000000" %) "sideEmails": [ ~/~/ (%%)Список электронных адресов для отсылки уведомлений 2867 +(% style="color:#000000" %) "string" 2868 + ], 2869 + "toTelegram": true, ~/~/ (%%)Флаг активности отправки в Telegram 2870 +(% style="color:#000000" %) "telegrams": [ ~/~/ (%%)Список получателя уведомлений в Telegram. 2871 +(% style="color:#000000" %) { 2872 + "id": 0, ~/~/ (%%)Идентификатор участника чата 2873 +(% style="color:#000000" %) "info": "string" ~/~/ (%%)Дополнительные сведения 2874 +(% style="color:#000000" %) } 2875 + ], 2876 + "toMobile": true, ~/~/ (%%)Флаг активности отправки в мобильное приложение 2877 +(% style="color:#000000" %) "toClient": true, ~/~/ (%%)Флаг активности отправки в интерфейсе системы 2878 +(% style="color:#000000" %) "stored": true, ~/~/ (%%)Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2879 +(% style="color:#000000" %) "kind": 0, ~/~/ (%%)Определяет вид уведомления 2880 +(% style="color:#000000" %) "activationMode": 0, ~/~/ (%%)Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2881 +(% style="color:#000000" %) "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ (%%)Дата/время активации правила (UTC) 2882 +(% style="color:#000000" %) "timezone": 0, ~/~/ (%%)Сдвиг часового пояса 2883 +(% style="color:#000000" %) "validity": 0, ~/~/ (%%)Срок действия в днях (1-90) 2884 +(% style="color:#000000" %) "autoProlongation": true ~/~/ (%%)Автопродление срока действия 2885 +(% style="color:#000000" %)} 2886 + 2887 +== (% style="color:#000000; font-size:16px" %)**Редактирование уведомления**(%%) == 2888 + 2889 +(% class="box warningmessage" %) 2890 +((( 2891 +**PUT /api/v3/notifications/** 2892 +))) 2893 + 2894 +Метод позволяет отредактировать уведомление. 2895 + 2896 +Метод запроса **PUT** 2897 + 2898 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications 2899 + 2900 +В заголовках запроса: X-Auth: Токен авторизации 2901 + 2902 +Тело запроса: 2903 +{ 2904 + "id": 0, ~/~/ id уведомления 2905 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2906 + "userId": "", ~/~/ Пользователь, создавший уведомление 2907 + "parentId": "", ~/~/ Идентификатор клиента 2908 + "parentName": "string", ~/~/ Имя клиента 2909 + "name": "string", ~/~/ Название уведомления 2910 + "active": true, ~/~/ Состояние true - активен, false - деактивирован 2911 + "vehicleIds": [ ~/~/ Список id объектов для анализа 1368 1368 0 1369 1369 ], 1370 - "geoids": [ 2914 + "geoids": [ ~/~/ Список id геообъектов для анализа 1371 1371 0 1372 1372 ], 1373 - "fieldids": [ 2917 + "fieldids": [ ~/~/ Список id полей для анализа 1374 1374 0 1375 1375 ], 1376 - "settings": { 2920 + "settings": { ~/~/ Список параметров уведомления 1377 1377 "additionalProp1": "string", 1378 1378 "additionalProp2": "string", 1379 1379 "additionalProp3": "string" 1380 1380 }, 1381 - "toEmail": true, 1382 - "recipientIds": [ 2925 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2926 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 1383 1383 "" 1384 1384 ], 1385 - "enableSideEmails": true, 1386 - "sideEmails": [ 2929 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2930 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 1387 1387 "string" 1388 1388 ], 1389 - "toTelegram": true, 1390 - "telegrams": [ 2933 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2934 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 1391 1391 { 1392 - "id": 0, 1393 - "info": "string" 2936 + "id": 0, ~/~/ Идентификатор участника чата 2937 + "info": "string" ~/~/ Дополнительные сведения 1394 1394 } 1395 1395 ], 1396 - "toMobile": true, 1397 - "toClient": true, 1398 - "stored": true, 1399 - "kind": 0, 1400 - "activationMode": 0, 1401 - "activationTime": "2023-03-29T09:57:48.932Z", 1402 - "timezone": 0, 1403 - "validity": 0, 1404 - "autoProlongation": true 2940 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2941 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2942 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2943 + "kind": 0, ~/~/ Определяет вид уведомления 2944 + "activationMode": 0, ~/~/ Вид активации уведомления 0 - Сейчас, 1 - В определенную дату и время 2945 + "activationTime": "2023-03-29T09:57:48.932Z", ~/~/ Дата и время активации правила (UTC) 2946 + "timezone": 0, ~/~/ Сдвиг часового пояса 2947 + "validity": 0, ~/~/ Срок действия в днях (1-90) 2948 + "autoProlongation": true ~/~/ Автопродление срока действия 1405 1405 } 1406 1406 2951 +Ответ: 1407 1407 2953 +Success 2954 + 2955 + 2956 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2957 + 2958 +(% class="box warningmessage" %) 2959 +((( 2960 +**PUT** /api/v3/notifications/prolongation 2961 +))) 2962 + 2963 +Метод позволяет продлить уведомления. 2964 + 2965 +Метод запроса **PUT** 2966 + 2967 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2968 + 2969 +В заголовках запроса: X-Auth: Токен авторизации. 2970 + 2971 +Тело запроса: 2972 + 2973 +[ 2974 + 2975 +0 2976 + 2977 +] 2978 + 2979 +где 0 идентификатор ids. 2980 + 2981 +== (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2982 + 2983 +(% class="box errormessage" %) 2984 +((( 2985 +**DELETE /api/v3/notifications/{id}** 2986 +))) 2987 + 2988 +Метод позволяет удалить выбранное уведомление. 2989 + 2990 +Метод запроса **DELETE** 2991 + 2992 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/{id} 2993 + 2994 +Передаваемый параметр: {id} - id уведомления 2995 + 2996 +В заголовках запроса: X-Auth: Токен авторизации 2997 + 2998 +Ответ: 2999 + 3000 +Success 3001 + 3002 + 3003 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 3004 + 3005 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 3006 + 3007 +(% class="box infomessage" %) 3008 +((( 3009 +**POST /api/v3/Drivers/find** 3010 +))) 3011 + 3012 +Передается параметр: parentId - ID клиента-родителя 3013 + 3014 +Ответ: 3015 + 3016 +[ 3017 + { 3018 + "name": "string", ~/~/ Определяет наименование 3019 + "description": "string", ~/~/ Определяет описание 3020 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3021 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3022 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3023 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3024 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3025 + "deleted": true ~/~/ Признак удаления 3026 + } 3027 +] 3028 + 3029 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 3030 + 3031 +(% class="box infomessage" %) 3032 +((( 3033 +**GET /api/v3/Drivers/{driverGuid}** 3034 +))) 3035 + 3036 +Передается параметр: ID водителя 3037 + 3038 +Ответ: 3039 + 3040 +{ 3041 + "name": "string", ~/~/ Определяет наименование 3042 + "description": "string", ~/~/ Определяет описание 3043 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3044 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3045 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3046 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3047 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3048 + "deleted": true ~/~/ Признак удаления 3049 +} 3050 + 3051 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 3052 + 3053 +(% class="box successmessage" %) 3054 +((( 3055 +**POST /api/v3/Drivers** 3056 +))) 3057 + 3058 +Запрос: 3059 + 3060 +{ 3061 + "name": "string", 3062 + "description": "string", 3063 + "hiredate": "2023-06-30T12:50:54.020Z", 3064 + "chopdate": "2023-06-30T12:50:54.020Z", 3065 + "exclusive": true, 3066 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3067 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3068 + "deleted": true 3069 +} 3070 + 3071 +Ответ: 3072 + 3073 +{ 3074 + "name": "string", 3075 + "description": "string", 3076 + "hiredate": "2023-06-30T12:50:54.051Z", 3077 + "chopdate": "2023-06-30T12:50:54.051Z", 3078 + "exclusive": true, 3079 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3080 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3081 + "deleted": true 3082 +} 3083 + 3084 + 3085 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3086 + 3087 +(% class="box warningmessage" %) 3088 +((( 3089 +**PUT /api/v3/Drivers** 3090 +))) 3091 + 3092 +Запрос: 3093 + 3094 +{ 3095 + "name": "string", 3096 + "description": "string", 3097 + "hiredate": "2023-06-30T12:50:27.910Z", 3098 + "chopdate": "2023-06-30T12:50:27.910Z", 3099 + "exclusive": true, 3100 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3101 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3102 + "deleted": true 3103 +} 3104 + 3105 +Ответ: 3106 + 3107 +{ 3108 + "name": "string", 3109 + "description": "string", 3110 + "hiredate": "2023-06-30T12:50:27.929Z", 3111 + "chopdate": "2023-06-30T12:50:27.929Z", 3112 + "exclusive": true, 3113 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3114 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3115 + "deleted": true 3116 +} 3117 + 3118 + 3119 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3120 + 3121 +(% class="box errormessage" %) 3122 +((( 3123 +**DELETE /api/v3/Drivers/{driverGuid}** 3124 +))) 3125 + 3126 +Передается параметр: ID водителя 3127 + 3128 +Ответ: 3129 + 3130 +Success 3131 + 3132 + 3133 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3134 + 3135 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3136 + 3137 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3138 + 3139 +(% class="box infomessage" %) 3140 +((( 3141 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3142 +))) 3143 + 3144 +Запрос: 3145 + 3146 +{ 3147 + "Ids": [ 3148 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3149 + ], 3150 + "BeginTime": "2023-06-30T12:49:04.365Z", 3151 + "EndTime": "2023-06-30T12:49:04.365Z" 3152 +} 3153 + 3154 +Ответ: 3155 + 3156 +[ 3157 + { 3158 + "VehicleId": 0, 3159 + "CreateTime": "2023-06-30T09:52:31.240Z", 3160 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3161 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3162 + "BeginTime": "2023-06-30T09:52:31.240Z", 3163 + "EndTime": "2023-06-30T09:52:31.240Z" 3164 + } 3165 +] 3166 + 3167 + 3168 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3169 + 3170 +(% class="box infomessage" %) 3171 +((( 3172 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3173 +))) 3174 + 3175 +Запрос: 3176 + 3177 +{ 3178 + "Ids": [ 3179 + 0 3180 + ], 3181 + "BeginTime": "2023-06-30T12:48:39.419Z", 3182 + "EndTime": "2023-06-30T12:48:39.419Z" 3183 +} 3184 + 3185 +Ответ: 3186 + 3187 +[ 3188 + { 3189 + "VehicleId": 0, 3190 + "CreateTime": "2023-06-30T09:54:01.631Z", 3191 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3192 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3193 + "BeginTime": "2023-06-30T09:54:01.631Z", 3194 + "EndTime": "2023-06-30T09:54:01.631Z" 3195 + } 3196 +] 3197 + 3198 + 3199 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3200 + 3201 +(% class="box successmessage" %) 3202 +((( 3203 +**POST /api/v3/DriversVehiclesAssignments** 3204 +))) 3205 + 3206 +Передается массив назначений 3207 + 3208 +Запрос: 3209 + 3210 +[ 3211 + { 3212 + "VehicleId": 0, ~/~/ Идентификатор объекта 3213 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3214 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3215 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3216 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3217 + } 3218 +] 3219 + 3220 +Ответ: 3221 + 3222 +[ 3223 + { 3224 + "VehicleId": 0, 3225 + "CreateTime": "2023-06-30T11:04:46.903Z", 3226 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3227 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3228 + "BeginTime": "2023-06-30T11:04:46.903Z", 3229 + "EndTime": "2023-06-30T11:04:46.903Z" 3230 + } 3231 +] 3232 + 3233 + 3234 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3235 + 3236 +(% class="box warningmessage" %) 3237 +((( 3238 +**PUT /api/v3/DriversVehiclesAssignments** 3239 +))) 3240 + 3241 +Запрос: 3242 + 3243 +[ 3244 + { 3245 + "VehicleId": 0, 3246 + "CreateTime": "2023-06-30T11:14:08.117Z", 3247 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3248 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3249 + "BeginTime": "2023-06-30T11:14:08.117Z", 3250 + "EndTime": "2023-06-30T11:14:08.117Z" 3251 + } 3252 +] 3253 + 3254 +Ответ: 3255 + 3256 +[ 3257 + { 3258 + "VehicleId": 0, 3259 + "CreateTime": "2023-06-30T11:14:53.349Z", 3260 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3261 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3262 + "BeginTime": "2023-06-30T11:14:53.349Z", 3263 + "EndTime": "2023-06-30T11:14:53.349Z" 3264 + } 3265 +] 3266 + 3267 + 3268 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3269 + 3270 +(% class="box errormessage" %) 3271 +((( 3272 +**DELETE /api/v3/DriversVehiclesAssignments** 3273 +))) 3274 + 3275 +Запрос: 3276 + 3277 +[ 3278 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3279 +] 3280 + 3281 +Ответ: 3282 + 3283 +Success 3284 + 3285 + 3286 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3287 + 3288 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3289 + 3290 +(% class="box infomessage" %) 3291 +((( 3292 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3293 +))) 3294 + 3295 +Запрос: 3296 + 3297 +{ 3298 + "Ids": [ 3299 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3300 + ], 3301 + "BeginTime": "2023-06-30T12:47:12.162Z", 3302 + "EndTime": "2023-06-30T12:47:12.162Z" 3303 +} 3304 + 3305 +Ответ: 3306 + 3307 +[ 3308 + { 3309 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3310 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3311 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3312 + "BeginTime": "2023-06-30T11:19:40.703Z", 3313 + "EndTime": "2023-06-30T11:19:40.703Z" 3314 + } 3315 +] 3316 + 3317 + 3318 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3319 + 3320 +(% class="box infomessage" %) 3321 +((( 3322 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3323 +))) 3324 + 3325 +Запрос: 3326 + 3327 +{ 3328 + "Ids": [ 3329 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3330 + ], 3331 + "BeginTime": "2023-06-30T12:47:12.162Z", 3332 + "EndTime": "2023-06-30T12:47:12.162Z" 3333 +} 3334 + 3335 +Ответ: 3336 + 3337 +[ 3338 + { 3339 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3340 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3341 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3342 + "BeginTime": "2023-06-30T11:19:40.703Z", 3343 + "EndTime": "2023-06-30T11:19:40.703Z" 3344 + } 3345 +] 3346 + 3347 + 3348 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3349 + 3350 +(% class="box successmessage" %) 3351 +((( 3352 +**POST /api/v3/DriversRfidsAssignments** 3353 +))) 3354 + 3355 +Запрос: 3356 + 3357 +[ 3358 + { 3359 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3360 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3361 + "BeginTime": "2023-06-30T11:27:08.635Z", 3362 + "EndTime": "2023-06-30T11:27:08.635Z" 3363 + } 3364 +] 3365 + 3366 +Ответ: 3367 + 3368 +[ 3369 + { 3370 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3371 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3372 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3373 + "BeginTime": "2023-06-30T11:27:08.677Z", 3374 + "EndTime": "2023-06-30T11:27:08.677Z" 3375 + } 3376 +] 3377 + 3378 + 3379 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3380 + 3381 +(% class="box warningmessage" %) 3382 +((( 3383 +**PUT /api/v3/DriversRfidsAssignments** 3384 +))) 3385 + 3386 +Запрос: 3387 + 3388 +[ 3389 + { 3390 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3391 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3392 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3393 + "BeginTime": "2023-06-30T11:28:43.330Z", 3394 + "EndTime": "2023-06-30T11:28:43.330Z" 3395 + } 3396 +] 3397 + 3398 +Ответ: 3399 + 3400 +[ 3401 + { 3402 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3403 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3404 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3405 + "BeginTime": "2023-06-30T11:28:43.331Z", 3406 + "EndTime": "2023-06-30T11:28:43.331Z" 3407 + } 3408 +] 3409 + 3410 + 3411 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3412 + 3413 +(% class="box errormessage" %) 3414 +((( 3415 +**DELETE /api/v3/DriversRfidsAssignments** 3416 +))) 3417 + 3418 +Запрос: 3419 + 3420 +[ 3421 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3422 +] 3423 + 3424 +Ответ: 3425 + 3426 +Success 3427 + 3428 + 3429 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3430 + 3431 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3432 + 3433 +(% class="box infomessage" %) 3434 +((( 3435 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3436 +))) 3437 + 3438 +Запрос: 3439 + 3440 +{ 3441 + "Ids": [ 3442 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3443 + ], 3444 + "BeginTime": "2023-06-30T12:45:10.852Z", 3445 + "EndTime": "2023-06-30T12:45:10.852Z" 3446 +} 3447 + 3448 +Ответ: 3449 + 3450 +[ 3451 + { 3452 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3453 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3454 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3455 + "BeginTime": "2023-06-30T11:58:04.695Z", 3456 + "EndTime": "2023-06-30T11:58:04.695Z" 3457 + } 3458 +] 3459 + 3460 + 3461 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3462 + 3463 +(% class="box infomessage" %) 3464 +((( 3465 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3466 +))) 3467 + 3468 +Запрос: 3469 + 3470 +{ 3471 + "Ids": [ 3472 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3473 + ], 3474 + "BeginTime": "2023-06-30T12:45:10.852Z", 3475 + "EndTime": "2023-06-30T12:45:10.852Z" 3476 +} 3477 + 3478 +Ответ: 3479 + 3480 +[ 3481 + { 3482 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3483 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3484 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3485 + "BeginTime": "2023-06-30T11:58:04.695Z", 3486 + "EndTime": "2023-06-30T11:58:04.695Z" 3487 + } 3488 +] 3489 + 3490 + 3491 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3492 + 3493 +(% class="box successmessage" %) 3494 +((( 3495 +**POST /api/v3/DriversFuelCardsAssignments** 3496 +))) 3497 + 3498 +Запрос: 3499 + 3500 +[ 3501 + { 3502 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3503 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3504 + "BeginTime": "2023-06-30T12:09:53.175Z", 3505 + "EndTime": "2023-06-30T12:09:53.175Z" 3506 + } 3507 +] 3508 + 3509 +Ответ: 3510 + 3511 +[ 3512 + { 3513 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3514 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3515 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3516 + "BeginTime": "2023-06-30T12:09:53.201Z", 3517 + "EndTime": "2023-06-30T12:09:53.201Z" 3518 + } 3519 +] 3520 + 3521 + 3522 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3523 + 3524 +(% class="box warningmessage" %) 3525 +((( 3526 +**PUT /api/v3/DriversFuelCardsAssignments** 3527 +))) 3528 + 3529 +Запрос: 3530 + 3531 +[ 3532 + { 3533 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3534 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3535 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3536 + "BeginTime": "2023-06-30T12:09:53.201Z", 3537 + "EndTime": "2023-06-30T12:09:53.201Z" 3538 + } 3539 +] 3540 + 3541 +Ответ: 3542 + 3543 +[ 3544 + { 3545 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3546 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3547 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3548 + "BeginTime": "2023-06-30T12:09:53.201Z", 3549 + "EndTime": "2023-06-30T12:09:53.201Z" 3550 + } 3551 +] 3552 + 3553 + 3554 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3555 + 3556 +(% class="box errormessage" %) 3557 +((( 3558 +**DELETE /api/v3/DriversFuelCardsAssignments** 3559 +))) 3560 + 3561 +Запрос: 3562 + 3563 +[ 3564 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3565 +] 3566 + 3567 +Ответ: 3568 + 3569 +Success 3570 + 3571 + 3572 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3573 + 3574 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3575 + 3576 +(% class="box infomessage" %) 3577 +((( 3578 +**POST /api/v3/Trailers** 3579 +))) 3580 + 3581 +Пример запроса: 3582 + 3583 +{ 3584 + "startDate": "2023-11-14T10:48:03.671Z", 3585 + "endDate": "2023-11-14T10:48:03.671Z", 3586 + "ids": [ 0 ], 3587 + "timezone": 0 3588 +} 3589 + 3590 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3591 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3592 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3593 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3594 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3595 + 3596 +Пример ответа: 3597 + 3598 +[ 3599 + { 3600 + "SD": "2023-11-14T10:48:03.717Z", 3601 + "ED": "2023-11-14T10:48:03.717Z", 3602 + "id": 0, 3603 + "SLat": 0, 3604 + "SLon": 0, 3605 + "ELat": 0, 3606 + "ELon": 0, 3607 + "mileage": 0 3608 + "Duration": 0 3609 + "Address": "string", 3610 + "Address2": "string", 3611 + "name": "string", 3612 + "rid": "string", 3613 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3614 + "trailer": { 3615 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3616 + "Number": "string", 3617 + "Description": "string", 3618 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3619 + "ExternalID": "string", 3620 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3621 + "CreateTime": "2023-11-14T10:48:03.717Z", 3622 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3623 + "IsDeleted": true 3624 + }, 3625 + "filesCount": 0, 3626 + } 3627 +] 3628 + 3629 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3630 +|SD|Дата и время начала события 3631 +|ED|Дата и время окончания события 3632 +|id|ID объекта 3633 +|SLat|Широта начальной координаты 3634 +|SLon|Долгота начальной координаты 3635 +|ELat|Широта конечной координаты 3636 +|ELon|Долгота конечной координаты 3637 +|mileage|Пробег 3638 +|Duration|Продолжительность 3639 +|Address|Адрес начального местоположения 3640 +|Address2|Адрес конечного местоположения 3641 +|name|Имя радиометки 3642 +|rid|Номер радиометки 3643 +|rguid|ID радиометки 3644 +|trailer|Информация об агрегате 3645 +|ModelGuid|ID агрегата 3646 +|Number|Название/номер агрегата 3647 +|Description|Текст примечания агрегата 3648 + 3649 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3650 + 3651 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3652 + 3653 +(% class="box infomessage" %) 3654 +((( 3655 +**POST /api/v3/Rfids/find** 3656 +))) 3657 + 3658 +Запрос: 3659 + 3660 +{ 3661 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3662 +} 3663 + 3664 +Ответ: 3665 + 3666 +[ 3667 + { 3668 + "name": "string", 3669 + "number": 0, 3670 + "period": 0, 3671 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3672 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3673 + } 3674 +] 3675 + 3676 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3677 +|parentId|ID клиента 3678 +|name|Название карты-метки 3679 +|number|Номер 3680 +|period|Период запросов в секундах (работает только для агрегатов) 3681 +|id|ID карты-метки 3682 + 3683 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3684 + 3685 +(% class="box infomessage" %) 3686 +((( 3687 +**GET /api/v3/Rfids/{rfidGuid}** 3688 +))) 3689 + 3690 +Передаем параметр rfidGuid - идентификатор карты-метки 3691 + 3692 +Ответ: 3693 + 3694 +[ 3695 + { 3696 + "name": "string", 3697 + "number": 0, 3698 + "period": 0, 3699 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3700 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3701 + } 3702 +] 3703 + 3704 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3705 +|name|Название карты-метки 3706 +|number|Номер 3707 +|period|Период запросов в секундах (работает только для агрегатов) 3708 +|id|ID карты-метки 3709 +|parentId|ID клиента 3710 + 3711 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3712 + 3713 +(% class="box successmessage" %) 3714 +((( 3715 +**POST /api/v3/Rfids** 3716 +))) 3717 + 3718 +Запрос: 3719 + 3720 +{ 3721 + "name": "string", 3722 + "number": 0, 3723 + "period": 0, 3724 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3725 +} 3726 + 3727 +Ответ: 3728 + 3729 +{ 3730 + "name": "string", 3731 + "number": 0, 3732 + "period": 0, 3733 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3734 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3735 +} 3736 + 3737 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3738 +|name|Название карты-метки 3739 +|number|Номер 3740 +|period|Период запросов в секундах (работает только для агрегатов) 3741 +|id|ID карты-метки 3742 +|parentId|ID клиента 3743 + 3744 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3745 + 3746 +(% class="box warningmessage" %) 3747 +((( 3748 +**PUT /api/v3/Rfids** 3749 +))) 3750 + 3751 +Запрос: 3752 + 3753 +{ 3754 + "name": "string", 3755 + "number": 0, 3756 + "period": 0, 3757 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3758 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3759 +} 3760 + 3761 +Ответ: 3762 + 3763 +{ 3764 + "name": "string", 3765 + "number": 0, 3766 + "period": 0, 3767 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3768 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3769 +} 3770 + 3771 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3772 +|name|Название карты-метки 3773 +|number|Номер 3774 +|period|Период запросов в секундах (работает только для агрегатов) 3775 +|id|ID карты-метки 3776 +|parentId|ID клиента 3777 + 3778 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3779 + 3780 +(% class="box errormessage" %) 3781 +((( 3782 +**DELETE /api/v3/Rfids/{rfidGuid}** 3783 +))) 3784 + 3785 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3786 + 3787 +Ответ: 3788 + 3789 +Success 3790 + 3791 + 3792 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3793 + 3794 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3795 + 3796 +(% class="box infomessage" %) 3797 +((( 3798 +**GET /api/v3/Billing/client/balance/{clientId}** 3799 +))) 3800 + 3801 +Параметр запроса: **clientId **- идентификатор клиента. 3802 + 3803 +Ответ: 3804 + 3805 +{ 3806 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3807 + "Balance": 0 3808 +} 3809 + 3810 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3811 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3812 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3813 + 3814 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3815 + 3816 +(% class="box infomessage" %) 3817 +((( 3818 +**GET /api/v3/Billing/client/constraint/{clientId}** 3819 +))) 3820 + 3821 +Параметр запроса: **clientId **- идентификатор клиента. 3822 + 3823 +Ответ: 3824 + 3825 +{ 3826 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3827 + "CalculationType": 0, 3828 + "PermissibleBalance": 0, 3829 + "DefermentDays": 0, 3830 + "SendUiNotifications": true, 3831 + "SendEmailNotifications": true, 3832 + "IsPrivate": true, 3833 +} 3834 + 3835 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3836 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3837 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3838 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3839 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3840 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3841 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3842 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3843 + 3844 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3845 + 3846 +(% class="box infomessage" %) 3847 +((( 3848 +**GET /api/v3/Billing/client/plan/{clientId}** 3849 +))) 3850 + 3851 +Параметры запроса: 3852 + 3853 +**clientId **- идентификатор клиента. 3854 + 3855 +**planId **- идентификатор тарифного плана. 3856 + 3857 +Ответ: 3858 + 3859 +{ 3860 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3861 + "Plan": { **~/~/ Описание тарифного плана** 3862 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3863 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3864 + "Name": "string", 3865 + "IsArchived": true, 3866 + "Constraint": { 3867 + "CalculationType": 0, 3868 + "PermissibleBalance": 0, 3869 + "DefermentDays": 0 3870 + }, 3871 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 3872 + { 3873 + "Feature": "string", 3874 + "IsFactual": true, 3875 + "Limit": 0, 3876 + "Price": 0, 3877 + "PeriodValue": 0, 3878 + "PeriodType": 0 3879 + } 3880 + ] 3881 + }, 3882 + "DebitDate": "2023-10-18T12:46:24.213Z", 3883 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 3884 + { 3885 + "Feature": "string", 3886 + "IsEnabled": true, 3887 + "IsPrivate": true, 3888 + "IsFactual": true, 3889 + "Limit": 0, 3890 + "Price": 0, 3891 + "DebitDate": "2023-10-18T12:46:24.213Z", 3892 + "PeriodValue": 0, 3893 + "PeriodType": 0 3894 + } 3895 + ] 3896 +} 3897 + 3898 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3899 +|ClientId|Идентификатор клиента 3900 +|Id|Идентификатор тарифного плана 3901 +|OwnerId|Идентификатор клиента-владельца 3902 +|Name|Наименование тарифного плана 3903 +|IsArchived|Признак, определяющий архивный тарифный план 3904 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3905 +|PermissibleBalance|Допустимый баланс 3906 +|DefermentDays|Отсрочка, количество дней 3907 +|Feature|Код услуги 3908 +|IsEnabled|Признак, определяющий активирована ли услуга 3909 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 3910 +|IsFactual|Признак, определяющий расчёт по факту 3911 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3912 +|Price|Цена за единицу. 3913 +|DebitDate|Следующий момент времени списания с баланса за услугу. 3914 +|PeriodValue|Значение периода. 3915 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3916 + 3917 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3918 + 3919 +(% class="box infomessage" %) 3920 +((( 3921 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3922 +))) 3923 + 3924 +Параметр запроса: **clientId **- идентификатор клиента. 3925 + 3926 +Ответ: 3927 + 3928 +[ 3929 + { 3930 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3931 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3932 + "Name": "string", 3933 + "IsArchived": true, 3934 + "Constraint": { 3935 + "CalculationType": 0, 3936 + "PermissibleBalance": 0, 3937 + "DefermentDays": 0 3938 + }, 3939 + "Features": [ 3940 + { 3941 + "Feature": "string", 3942 + "IsFactual": true, 3943 + "Limit": 0, 3944 + "Price": 0, 3945 + "PeriodValue": 0, 3946 + "PeriodType": 0 3947 + } 3948 + ] 3949 + } 3950 +] 3951 + 3952 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3953 +|ClientId|Идентификатор клиента 3954 +|Id|Идентификатор тарифного плана 3955 +|OwnerId|Идентификатор клиента-владельца 3956 +|Name|Наименование тарифного плана 3957 +|IsArchived|Признак, определяющий архивный тарифный план 3958 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 3959 +|PermissibleBalance|Допустимый баланс 3960 +|DefermentDays|Отсрочка, количество дней 3961 +|Feature|Код услуги 3962 +|IsFactual|Признак, определяющий расчёт по факту 3963 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 3964 +|Price|Цена за единицу. 3965 +|PeriodValue|Значение периода. 3966 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3967 + 3968 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3969 + 3970 +(% class="box infomessage" %) 3971 +((( 3972 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 3973 +))) 3974 + 3975 +Параметр запроса: **clientId **- идентификатор клиента. 3976 + 3977 +Ответ: 3978 + 3979 +[ 3980 + { 3981 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3982 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3983 + "Name": "string", 3984 + "IsArchived": true, 3985 + "Constraint": { 3986 + "CalculationType": 0, 3987 + "PermissibleBalance": 0, 3988 + "DefermentDays": 0 3989 + }, 3990 + "Features": [ 3991 + { 3992 + "Feature": "string", 3993 + "IsFactual": true, 3994 + "Limit": 0, 3995 + "Price": 0, 3996 + "PeriodValue": 0, 3997 + "PeriodType": 0 3998 + } 3999 + ] 4000 + } 4001 +] 4002 + 4003 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4004 +|ClientId|Идентификатор клиента 4005 +|Id|Идентификатор тарифного плана 4006 +|OwnerId|Идентификатор клиента-владельца 4007 +|Name|Наименование тарифного плана 4008 +|IsArchived|Признак, определяющий архивный тарифный план 4009 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4010 +|PermissibleBalance|Допустимый баланс 4011 +|DefermentDays|Отсрочка, количество дней 4012 +|Feature|Код услуги 4013 +|IsFactual|Признак, определяющий расчёт по факту 4014 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4015 +|Price|Цена за единицу. 4016 +|PeriodValue|Значение периода. 4017 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4018 + 4019 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4020 + 4021 +(% class="box warningmessage" %) 4022 +((( 4023 +**PUT /api/v3/Billing/client/balance** 4024 +))) 4025 + 4026 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4027 + 4028 +Тело запроса: 4029 + 4030 +{ 4031 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4032 + "Balance": 0 ~/~/ Значение баланса. 4033 +} 4034 + 4035 +Ответ: Success 4036 + 4037 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4038 + 4039 +(% class="box warningmessage" %) 4040 +((( 4041 +**PUT /api/v3/billing/client/balance/deposit** 4042 +))) 4043 + 4044 +Создает операцию **Пополнение **с указанной суммой 4045 + 4046 +Тело запроса: 4047 + 4048 +((( 4049 +{ 4050 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4051 + "amount": 0 ~/~/ Сумма пополнения баланса 4052 +} 4053 +))) 4054 + 4055 +((( 4056 + 4057 +))) 4058 + 4059 +Ответ: Success 4060 + 4061 +((( 4062 +{ 4063 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4064 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4065 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4066 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4067 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4068 + "Description": "string" ~/~/ Описание корректировки. 4069 +} 4070 +))) 4071 + 4072 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4073 + 4074 +Создает операцию **Списание **с указанной суммой 4075 + 4076 +(% class="box warningmessage" %) 4077 +((( 4078 +**PUT /api/v3/billing/client/balance/withdraw** 4079 +))) 4080 + 4081 +Тело запроса: 4082 + 4083 +((( 4084 +{ 4085 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4086 + "amount": 0 ~/~/ Сумма списания с баланса 4087 +} 4088 +))) 4089 + 4090 +Ответ: Success 4091 + 4092 +((( 4093 +{ 4094 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4095 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4096 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4097 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4098 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4099 + "Description": "string" ~/~/ Описание корректировки 4100 +} 4101 +))) 4102 + 4103 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4104 + 4105 +(% class="box warningmessage" %) 4106 +((( 4107 +**PUT /api/v3/Billing/client/constraint** 4108 +))) 4109 + 4110 +Тело запроса: 4111 + 4112 +((( 4113 +{ 4114 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4115 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4116 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4117 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4118 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4119 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4120 +} 4121 +))) 4122 + 4123 +((( 4124 + 4125 +))) 4126 + 4127 +Ответ: Success 4128 + 4129 +((( 4130 +{ 4131 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4132 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4133 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4134 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4135 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4136 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4137 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4138 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4139 +} 4140 +))) 4141 + 4142 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4143 + 4144 +(% class="box warningmessage" %) 4145 +((( 4146 +**PUT /api/v3/Billing/client/plan** 4147 +))) 4148 + 4149 +Тело запроса: 4150 + 4151 +{ 4152 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4153 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4154 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4155 + { 4156 + "Feature": "string", ~/~/ Код услуги. 4157 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4158 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4159 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4160 + "Price": 0, ~/~/ Цена за единицу. 4161 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4162 + "PeriodValue": 0, ~/~/ Значение периода. 4163 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4164 + } 4165 + ] 4166 +} 4167 + 4168 + 4169 +Ответ: Success 4170 + 4171 +((( 4172 +{ 4173 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4174 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4175 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4176 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4177 + "Name": "string", ~/~/ Наименование. 4178 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4179 + "Constraint": { ~/~/ Ограничения по тарифу 4180 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4181 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4182 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4183 + }, 4184 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4185 + { 4186 + "Feature": "string", ~/~/Код услуги. 4187 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4188 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4189 + "Price": 0, ~/~/ Цена за единицу. 4190 + "PeriodValue": 0, ~/~/ Значение периода. 4191 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4192 + } 4193 + ], 4194 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4195 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4196 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4197 + }, 4198 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4199 + { 4200 + "Feature": "string", ~/~/ Код услуги. 4201 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4202 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4203 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4204 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4205 + "Price": 0, ~/~/ Цена за единицу. 4206 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4207 + "PeriodValue": 0, ~/~/ Значение периода. 4208 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4209 + "Quantity": 0 ~/~/ Количество использования услуги. 4210 + } 4211 + ] 4212 +} 4213 +))) 4214 + 4215 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4216 + 4217 +(% class="box warningmessage" %) 4218 +((( 4219 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4220 +))) 4221 + 4222 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4223 + 4224 +(% class="box infomessage" %) 4225 +((( 4226 +**POST /api/v3/vehicles/import/{agentId}** 4227 +))) 4228 + 4229 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4230 + 4231 +В пути указывается **agentId** - id клиента. 4232 + 4233 +**Заголовок** 4234 + 4235 +**X-Auth: [токен авторизации]** 4236 + 4237 +**Параметры** 4238 + 4239 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4240 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4241 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4242 + 4243 +В теле использовать тип **form-data,** тип значения** file** 4244 + 4245 +**Ключи** 4246 + 4247 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4248 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4249 +|csv|В значении передаем файл датчиков, формат **csv** 4250 + 4251 +Ответ: 4252 + 4253 +{ 4254 + "vehicleId": 0, 4255 + "name": "string", 4256 + "errors": ["string"] 4257 +} 4258 + 4259 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4260 +|vehicleId|ID созданного объекта 4261 +|name|Имя созданного объекта 4262 +|errors|Ошибки и их описание 4263 + 4264 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4265 + 4266 +(% class="box infomessage" %) 4267 +((( 4268 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4269 +))) 4270 + 4271 +(% class="wikigeneratedid" %) 4272 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4273 + 4274 +(% class="wikigeneratedid" %) 4275 +В пути указывается **vehicleId **- id объекта. 4276 + 4277 +**Заголовок** 4278 + 4279 +**X-Auth: [токен авторизации]** 4280 + 4281 +В теле использовать тип **form-data.** 4282 + 4283 +Ключи: 4284 + 4285 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4286 +|**history**|В значении передавать файл с историей 4287 + 4288 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4289 + 4290 +Ответ: 4291 + 4292 +{ 4293 + "results": [ 4294 + { 4295 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4296 + "vehicleId": 0, 4297 + "errors": [ 4298 + "string" 4299 + ], 4300 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4301 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4302 + "producedCount": 0, 4303 + "msgCount": 0 4304 + } 4305 + ] 4306 +} 4307 + 4308 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4309 +|results|Результаты импорта в разрезе ТС 4310 +|vehicleGuid|Guid ТС 4311 +|vehicleId|ID ТС 4312 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4313 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4314 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4315 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4316 +|msgCount|Кол-во обработанных сообщений всего 4317 + 4318 +== **Импортировать историю ТС (Асинхронный запрос)** == 4319 + 4320 +(% class="box successmessage" %) 4321 +((( 4322 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4323 +))) 4324 + 4325 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4326 + 4327 +Метод запроса: **POST** 4328 + 4329 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4330 + 4331 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4332 + 4333 + 4334 +Ответ: 4335 + 4336 +{ 4337 + 4338 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4339 + 4340 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4341 + 4342 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4343 + 4344 + "Message": "string", ~/~/ Информация о выполнении запроса 4345 + 4346 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4347 + 4348 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4349 + 4350 + "Data": "string" ~/~/ Данные 4351 + 4352 +} 4353 + 4354 + 4355 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4356 + 4357 +(% class="box infomessage" %) 4358 +((( 4359 +**GET /api/v3/vehicles/import/history/status** 4360 +))) 4361 + 4362 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4363 + 4364 +Ответ: 4365 + 4366 +{ 4367 + "activity": true, 4368 + "progress": 0, 4369 + "message": "string" 4370 +} 4371 + 4372 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4373 +**Параметр** 4374 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4375 +**Описание** 4376 +))) 4377 +|((( 4378 +activity 4379 +)))|((( 4380 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4381 +))) 4382 +|((( 4383 +progress 4384 +)))|((( 4385 +Guid ТС 4386 +))) 4387 + 4388 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4389 + 4390 +(% class="box infomessage" %) 4391 +((( 4392 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4393 +))) 4394 + 4395 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4396 + 4397 +Метод запроса: **GET** 4398 + 4399 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4400 + 4401 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4402 + 4403 + 4404 +Ответ: 4405 + 4406 +{ 4407 + 4408 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4409 + 4410 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4411 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4412 + 4413 + "Message": "string", ~/~/ Информация о выполнении запроса 4414 + 4415 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4416 + 4417 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4418 + 4419 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4420 + 4421 + "Data": "string" ~/~/ Данные 4422 + 4423 +} 4424 + 4425 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4426 + 4427 +(% class="box infomessage" %) 4428 +((( 4429 +**POST /api/v3/vehicles/export** 4430 +))) 4431 + 4432 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4433 + 4434 +Тело запроса: 4435 + 4436 +[ 4437 + id 4438 +] 4439 + 4440 +Ответ: Success 200, получаете файлы с настройками. 4441 + 4442 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4443 + 4444 +(% class="box infomessage" %) 4445 +((( 4446 +**POST /api/v3/vehicles/export/history** 4447 +))) 4448 + 4449 +Метод возвращает список сообщений терминала объекта за выбранный период. 4450 + 4451 +Тело запроса: 4452 + 4453 +{ 4454 + "vehicleId": 0, 4455 + "asArchive": true, 4456 + "from": "2023-09-27T12:17:45.973Z", 4457 + "to": "2023-09-27T12:17:45.973Z" 4458 +} 4459 + 4460 +Ответ: 4461 + 4462 +Получаете файл. Сообщение: Code 200/Success 4463 + 4464 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4465 +|vehicleId|ID объекта 4466 +|asArchive|true - Архивировать файл, False - не архивировать 4467 +|from|Дата и время начала запроса 4468 +|to|Дата и время окончания запроса 4469 + 4470 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4471 + 4472 +(% class="box infomessage" %) 4473 +((( 4474 +**GET /api/v3/vehicles/export/history/status** 4475 +))) 4476 + 4477 +Метод возвращает список сообщений терминала объекта за выбранный период. 4478 + 4479 +Ответ: 4480 + 4481 +{ 4482 + "activity": true, 4483 + "progress": 0, 4484 + "message": "string" 4485 +} 4486 + 4487 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4488 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4489 +|progress|Прогресс экспорта, от 0 до 100% 4490 +|message|Текст описывающий статус 4491 + 4492 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4493 + 4494 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4495 + 4496 +(% class="box infomessage" %) 4497 +((( 4498 +**POST /api/v3/EcoDriving/rating** 4499 +))) 4500 + 4501 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4502 + 4503 +Тело запроса: 4504 + 4505 +{ 4506 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4507 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4508 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4509 +} 4510 + 4511 +Ответ: 4512 + 4513 +{ 4514 + "items": [ ~/~/ Список в разрезе ТС 4515 + { 4516 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4517 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4518 + "vehicleId": 0, ~/~/ ID ТС 4519 + "vehicleName": "string", ~/~/ Название ТС 4520 + "vehicleModel": "string", ~/~/ Модель ТС 4521 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4522 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4523 + "totalViolations": 0, ~/~/ Нарушений всего 4524 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4525 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4526 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4527 + "brakingViolations": 0, ~/~/ Нарушений торможения 4528 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4529 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4530 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4531 + }, 4532 + 4533 +((( 4534 + 4535 +))) 4536 + 4537 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4538 + "mileage": 0, ~/~/ Пробег, м 4539 + "tripsCount": 0, ~/~/ Кол-во рейсов 4540 + "trips": [ ~/~/ Информация по рейсу 4541 + { 4542 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4543 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4544 + "violationsCount": 0, ~/~/ Всего нарушений 4545 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4546 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4547 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4548 + "brakingViolations": 0, ~/~/ Нарушений торможения 4549 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4550 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4551 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4552 + }, 4553 + 4554 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4555 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4556 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4557 + "mileage": 0, ~/~/ Пробег, м 4558 + "motohours": 0, ~/~/ Моточасы, секунды 4559 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4560 + "startAddress": "string", ~/~/ Адрес начала рейса 4561 + "endAddress": "string", ~/~/ Адрес конца рейса 4562 + "drivers": [ ~/~/ Список водителей 4563 + { 4564 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4565 + "driverName": "string", ~/~/ФИО водителя 4566 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4567 + } 4568 + ] 4569 + } 4570 + ] 4571 + } 4572 + ] 4573 +} 4574 + 4575 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4576 + 4577 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4578 + 4579 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4580 + 4581 +(% class="box infomessage" %) 4582 +((( 4583 +**POST /api/v3/fuelcards/transactions** 4584 +))) 4585 + 4586 +Метод запроса: POST 4587 + 4588 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4589 +\\В заголовках запроса: X-Auth: Токен авторизации 4590 + 4591 +Параметры в теле запроса (JSON): 4592 + 4593 +{ 4594 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4595 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4596 + "ids": [ 4597 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4598 + ], 4599 + "timezone": 0 ~/~/ Часовой пояс 4600 +} 4601 + 4602 + 4603 +Ответ: 4604 + { 4605 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4606 + "driver": "string", ~/~/ Водители, привязанные к ТК 4607 + "object": "string", ~/~/ Наименование ТС 4608 + "amount": 0, ~/~/ Количество топлива 4609 + "amountDut": 0, ~/~/ Количество по ДУТ 4610 + "amountDiff": 0, ~/~/ Разница, л 4611 + "amountDiffPerc": 0, ~/~/ Разница, % 4612 + "summa": 0, ~/~/ Стоимость, руб 4613 + "serviceName": "string", ~/~/ Тип топлива 4614 + "price": 0, ~/~/ Цена за литр, руб 4615 + "cardName": "string", ~/~/ Наименование ТК 4616 + "cardNum": "string", ~/~/ Номер ТК 4617 + "operator": "string", ~/~/ Оператор ТК 4618 + "address": "string" ~/~/ Адрес АЗС 4619 + } 4620 + 4621 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4622 + 4623 +(% class="box infomessage" %) 4624 +((( 4625 +**GET /api/v3/fuelcards** 4626 +))) 4627 + 4628 +Метод запроса: GET 4629 + 4630 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4631 + 4632 +Ответ: 4633 + 4634 +[ 4635 + { 4636 + "Name": "string", ~/~/ Определяет наименование карты. 4637 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4638 + "Number": "string", ~/~/ Определяет № карты. 4639 + "Enabled": true, ~/~/ Определяет признак активности карты. 4640 + "Description": "string", ~/~/ Определяет описание карты. 4641 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4642 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4643 + "deleted": true ~/~/ Признак удаления 4644 + } 4645 +] 4646 + 4647 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4648 + 4649 + 4650 +== **Получение полных данных о ретрансляторе** == 4651 + 4652 +(% class="box infomessage" %) 4653 +((( 4654 +**GET ** **/api/v3/retranslations/{id}** 4655 +))) 4656 + 4657 +id - Идентификатор ретранслятора 4658 + 4659 + 4660 +Пример ответа: 4661 + 4662 +{ 4663 +"description": "", ~/~/ Поле описания ретранслятора 4664 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4665 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4666 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4667 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4668 +"objects": [ ~/~/ Объекты для ретрансляции 4669 +{ 4670 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4671 +"name": "", ~/~/ Наименование объекта ретрансляции 4672 +"imei": "", ~/~/ IMEI объекта ретрансляции 4673 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4674 +} 4675 + ], 4676 +"id": "", ~/~/ Идентификатор ретранслятора 4677 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4678 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4679 +} 4680 + 4681 + 4682 +== **Удаление данных ретранслятора** == 4683 + 4684 +(% class="box infomessage" %) 4685 +((( 4686 +**DELETE** **/api/v3/retranslations/{id}** 4687 +))) 4688 + 4689 +id - Идентификатор ретранслятора 4690 + 4691 + 4692 +== **Создание ретранслятора** == 4693 + 4694 +(% class="box infomessage" %) 4695 +((( 4696 +**POST ** **/api/v3/retranslations/{id}** 4697 +))) 4698 + 4699 +Запрос: 4700 + 4701 +{ 4702 +"description": "", ~/~/ Поле описания ретранслятора 4703 +"subscriberId": "", ~/~/ Идентификатор подписчика 4704 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4705 +"address": "", ~/~/ Адрес и порт принимающего сервера 4706 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4707 +"objects": [ ~/~/Объекты для ретрансляции 4708 +{ 4709 +"id": "", ~/~/ Идентификатор ретранслятора 4710 +"imei": "", ~/~/ IMEI объекта ретрансляции 4711 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4712 +} 4713 + ] 4714 +} 4715 + 4716 + 4717 +Ответ: 4718 + 4719 +{ 4720 +"description": "", ~/~/ Поле описания ретранслятора 4721 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4722 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4723 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4724 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4725 +"objects": [ ~/~/ Объекты для ретрансляции 4726 +{ 4727 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4728 +"name": "string", ~/~/ Наименование объекта ретрансляции 4729 +"imei": "", ~/~/ IMEI объекта ретрансляции 4730 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4731 +} 4732 + ], 4733 +"id": "", ~/~/ Идентификатор ретранслятора 4734 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4735 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4736 +} 4737 + 4738 + 4739 +== **Редактирование ретранслятора** == 4740 + 4741 +(% class="box infomessage" %) 4742 +((( 4743 +**PUT** **/api/v3/retranslations** 4744 +))) 4745 + 4746 +Пример запроса: 4747 + 4748 +{ 4749 +"id": "", ~/~/ Идентификатор ретранслятора 4750 +"description": "string", ~/~/ Поле описания ретранслятора 4751 +"subscriberId": "", ~/~/ Идентификатор подписчика 4752 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4753 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4754 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4755 +"objects": ~/~/ Объекты для ретрансляции 4756 +[ 4757 +{ 4758 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4759 +"imei": "", ~/~/ IMEI объекта ретрансляции 4760 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4761 +} 4762 + ] 4763 +} 4764 + 4765 + 4766 +Пример ответа: 4767 + 4768 +{ 4769 +"description": "", ~/~/ Поле описания ретранслятора 4770 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4771 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4772 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4773 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4774 +"objects": [ ~/~/ Объекты для ретрансляции 4775 +{ 4776 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4777 +"name": "string", ~/~/ Наименование объекта ретрансляции 4778 +"imei": "", ~/~/ IMEI объекта ретрансляции 4779 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4780 +} 4781 + ], 4782 +"id": "", ~/~/ Идентификатор ретранслятора 4783 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4784 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4785 +} 4786 + 4787 + 4788 +== **Получение списка ретранслятора клиента** == 4789 + 4790 +(% class="box infomessage" %) 4791 +((( 4792 +**POST /api/v3/retranslations/find** 4793 +))) 4794 + 4795 +Пример запроса: 4796 + 4797 +{ 4798 +"id": "", ~/~/ Идентификатор ретранслятора 4799 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4800 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4801 +} 4802 + 4803 +Ответ: 4804 + 4805 +[ 4806 +{ 4807 +"description": "", ~/~/ Поле описания ретранслятора 4808 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4809 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4810 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4811 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4812 +"id": "", ~/~/ Идентификатор ретранслятора 4813 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4814 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4815 +} 4816 +] 4817 + 4818 + 4819 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4820 + 4821 +== **API для отчета по выгрузке комбайнов** == 4822 + 4823 +(% class="box infomessage" %) 4824 +((( 4825 +**POST /api/v3/Reports/harvesterUnloading** 4826 +))) 4827 + 4828 +Пример запроса: 4829 + 4830 +{ 4831 + "byTime": 0, ~/~/ Объединение событий по времени 4832 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4833 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4834 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4835 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4836 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4837 + 0 4838 + ], 4839 + "from": "", ~/~/ Дата и время начало запроса 4840 + "to": "", ~/~/ Дата и время окончания запроса 4841 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4842 +} 4843 + 4844 +Пример ответа: 4845 + 4846 +[ 4847 + { 4848 + "harvesterName": "", ~/~/Комбайн, номер 4849 + "harvesterId": 0, ~/~/Комбайн, id 4850 +"harvesterModel": "", ~/~/ Модель комбайна 4851 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4852 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4853 + "events": [ ~/~/Список событий в разрезе комбайна 4854 + { 4855 + "driverId": "", ~/~/Идентификатор водителя 4856 + "driverName": "", ~/~/Водитель комбайна, ФИО 4857 + "RFID": "", ~/~/ идентификатор карты-метки 4858 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4859 + "vehicleId": 0, ~/~/идентификатор объекта 4860 + "vehicleName": "string", ~/~/ Имя объекта 4861 + "modelName": "string", ~/~/ Имя модели объекта 4862 + "nearestVehicles": [ ~/~/Объекты рядом 4863 + { 4864 + "vehicleId": 0, ~/~/идентификатор объекта 4865 + "vehicleName": "string" ~/~/ Имя объекта 4866 + } 4867 + ], 4868 + "fields": [ ~/~/Поля, где происходила выгрузка 4869 + { 4870 + "id": 0, ~/~/ идентификатор пользователя 4871 + "name": "string" ~/~/ имя пользователя 4872 + } 4873 + ], 4874 + "event": "string", ~/~/Событие 4875 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4876 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4877 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4878 + "cultureName": "string", ~/~/ название культуры 4879 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4880 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4881 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4882 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4883 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4884 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4885 + "issued": 0, ~/~/Выдано, бункеров 4886 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4887 + "latitude": 0, ~/~/Широта 4888 + "longitude": 0, ~/~/ Долгота 4889 + "litresAway": 0, ~/~/Отдано, л 4890 + "m3Away": 0 ~/~/Отдано, м3 4891 + } 4892 + ] 4893 + } 4894 +] 4895 + 4896 + 4897 +== **Отчет трек-датчики** == 4898 + 4899 +(% class="box infomessage" %) 4900 +((( 4901 +**POST /api/v3/Reports/sensorsWorks** 4902 +))) 4903 + 4904 +**Пример запроса:** 4905 + 4906 +{ 4907 + "vehicleIds": [ ~/~/ Список ID объектов 4908 + 0 4909 + ], 4910 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4911 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4912 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4913 +} 4914 + 4915 +**Пример ответа:** 4916 + 4917 +((( 4918 +{ 4919 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4920 + { 4921 + "vehicleId": 0, ~/~/ Идентификатор ТС 4922 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4923 + { 4924 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4925 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4926 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4927 + "name": "string", ~/~/ Наименование оборудования. 4928 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4929 + "totalMileage": 0, ~/~/ Общий пробег. 4930 + "avgSpeed": 0 ~/~/ Средняя скорость. 4931 + } 4932 + ] 4933 + } 4934 + ] 4935 +} 4936 + 4937 + 4938 +== **Превышение скорости** == 4939 + 4940 +(% class="box infomessage" %) 4941 +((( 4942 +**POST /api/v3/Reports/overSpeedDuration** 4943 +))) 4944 + 4945 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4946 + 4947 +Пример запроса: 4948 + 4949 +((( 4950 +{ 4951 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4952 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4953 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4954 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4955 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4956 +} 4957 +))) 4958 + 4959 +((( 4960 + 4961 +))) 4962 + 4963 +((( 4964 +Пример ответа: 4965 +))) 4966 + 4967 +((( 4968 +((( 4969 +[ 4970 + { 4971 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4972 + "duration": 0, ~/~/ Продолжительность события в секундах 4973 + "maxSpeed": 0, ~/~/ Максимальная скорость 4974 + "speedLimit": 0 ~/~/ Ограничение скорости 4975 + } 4976 +] 4977 +))) 4978 +))) 4979 +))) 4980 + 4981 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4982 + 4983 + 4984 +== **Запрос списка полей** == 4985 + 4986 +(% class="box successmessage" %) 4987 +((( 4988 +**POST /api/v3/agroLands/find** 4989 +))) 4990 + 4991 +Пример запроса: 4992 + 4993 +((( 4994 +((( 4995 +((( 4996 +{ 4997 + "year": 0, ~/~/ Фильтр по году 4998 + "name": "string", ~/~/ Фильтр по названию 4999 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5000 +} 5001 +))) 5002 +))) 5003 + 5004 + 5005 +))) 5006 + 5007 +Пример ответа: 5008 + 5009 +((( 5010 +[ 5011 + { 5012 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5013 + "year": 0, ~/~/ Год поля 5014 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5015 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5016 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5017 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5018 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5019 + "counts": { ~/~/ Счётчики с/х поля 5020 + "fieldOperations": 0, ~/~/ Количество операций на поле 5021 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5022 + "facts": 0 ~/~/ Счётчик факта 5023 + }, 5024 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5025 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5026 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5027 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5028 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5029 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5030 + "planComment": "string", ~/~/ Комментарий к полю 5031 + "productivity": 0, ~/~/ Урожайность. 5032 + "id": 0, ~/~/ Идентификатор объекта геозоны 5033 + "name": "string", ~/~/ Название объекта геозоны 5034 + "type": 0, ~/~/ Тип объекта геозоны 5035 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5036 + "fname": "string", ~/~/ Имя файла 5037 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5038 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5039 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5040 + "description": "string", ~/~/ Описание объекта геозоны 5041 + "area": 0, ~/~/ Площадь, м2 5042 + "perimetr": 0, ~/~/ Периметр, м 5043 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5044 + } 5045 +] 5046 + 5047 + 5048 +== **Создание нового поля ** == 5049 + 5050 +(% class="box successmessage" %) 5051 +((( 5052 +**POST /api/v3/agroLands** 5053 +))) 5054 + 5055 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5056 +X-agent - ID клиента 5057 + 5058 +Пример запроса: 5059 + 5060 +((( 5061 +{ 5062 + "extId": "string", 5063 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5064 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5065 + "display": "string", ~/~/ Настройки отображения 5066 + "year": 0, ~/~/ Год поля 5067 + "name": "string", ~/~/ Наименование 5068 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5069 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5070 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5071 + "planComment": "string", ~/~/ Комментарий к полю 5072 + "cropRotations": [ ~/~/ Данные по севообороту 5073 + { 5074 + "landId": 0, ~/~/ ID поля 5075 + "landName": "string", ~/~/ Название поля 5076 + "year": 0, ~/~/ Год урожая 5077 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5078 + "cultureName": "string", ~/~/ Название культуры 5079 + "productivity": 0, ~/~/ Урожайность 5080 + "area": 0, ~/~/ Площадь поля, Га 5081 + "total": 0, ~/~/ Валовый сбор 5082 + "productivityFact": 0, ~/~/ Фактическая урожайность 5083 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5084 + "totalFact": 0, ~/~/ Фактический валовый сбор 5085 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5086 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5087 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5088 + "isyearplan": true, ~/~/ Годовой план 5089 + "comment": "string" ~/~/ Комментарий 5090 + } 5091 + ] 5092 +} 5093 +))) 5094 + 5095 +((( 5096 + 5097 +))) 5098 + 5099 +Пример ответа: 5100 + 5101 +((( 5102 +((( 5103 +{ 5104 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5105 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5106 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5107 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5108 + "cropRotations": [ ~/~/ Данные по севообороту 5109 + { 5110 + "landId": 0, ~/~/ ID поля 5111 + "landName": "string", ~/~/ Название поля 5112 + "year": 0, ~/~/ Год урожая 5113 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5114 + "cultureName": "string", ~/~/ Название культуры 5115 + "productivity": 0, ~/~/ Урожайность 5116 + "area": 0, ~/~/ Площадь поля, Га. 5117 + "total": 0, ~/~/ Валовый сбор 5118 + "productivityFact": 0, ~/~/ Фактическая урожайность 5119 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5120 + "totalFact": 0, ~/~/ Фактический валовый сбор 5121 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5122 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5123 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5124 + "isyearplan": true, ~/~/ годовой план 5125 + "comment": "string" ~/~/ Комментарий 5126 + } 5127 + ], 5128 + "cropVegetation": [ ~/~/ История вегетации поля 5129 + { 5130 + "values": [ ~/~/ Данные вегетации и состояния посева 5131 + { 5132 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5133 + "ndvi": 0 ~/~/ Индекс вегетации 5134 + } 5135 + ], 5136 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5137 + { 5138 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5139 + "type": "string", ~/~/ Тип 5140 + "pictureid": "string" ~/~/ Идентификатор ресурса 5141 + } 5142 + ], 5143 + "states": [ ~/~/ Ключевые даты развития поля 5144 + { 5145 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5146 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5147 + } 5148 + ] 5149 + } 5150 + ], 5151 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5152 + "counts": { 5153 + "fieldOperations": 0, ~/~/ Количество операций на поле 5154 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5155 + "facts": 0 ~/~/ Счётчик факта 5156 + }, 5157 + "planComment": "string", ~/~/ Комментарий к полю 5158 +))) 5159 + 5160 +((( 5161 + "productivity": 0, ~/~/ Урожайность. 5162 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5163 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5164 + "year": 0, ~/~/ Год поля 5165 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5166 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5167 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5168 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5169 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5170 + "id": 0, ~/~/ Идентификатор объекта геозоны 5171 + "name": "string", ~/~/ Название объекта геозоны 5172 + "type": 0, ~/~/ Тип объекта геозоны 5173 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5174 + "fname": "string", ~/~/ Имя файла 5175 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5176 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5177 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5178 + "description": "string", ~/~/ Описание объекта геозоны 5179 + "area": 0, ~/~/ Площадь, м2 5180 + "perimetr": 0, ~/~/ Периметр, м 5181 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5182 +} 5183 + 5184 + 5185 +))) 5186 +))) 5187 +))) 5188 + 5189 +== **Получение поля по id** == 5190 + 5191 +(% class="box infomessage" %) 5192 +((( 5193 +**GET /api/v3/agroLands/{id}** 5194 +))) 5195 + 5196 +Пример запроса: 5197 +id ~/~/ Идентификатор поля 5198 + 5199 +Пример ответа: 5200 + 5201 +((( 5202 +{ 5203 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5204 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5205 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5206 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5207 + "cropRotations": [ ~/~/ Данные по севообороту 5208 + { 5209 + "landId": 0, ~/~/ ID поля 5210 + "landName": "string", ~/~/ Название поля 5211 + "year": 0, ~/~/ Год урожая 5212 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5213 + "cultureName": "string", ~/~/ Название культуры 5214 + "productivity": 0, ~/~/ Урожайность 5215 + "area": 0, ~/~/ Площадь поля, Га 5216 + "total": 0, ~/~/ Валовый сбор 5217 + "productivityFact": 0, ~/~/ Фактическая урожайность 5218 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5219 + "totalFact": 0, ~/~/ Фактический валовый сбор 5220 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5221 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5222 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5223 + "isyearplan": true, ~/~/ План года 5224 + "comment": "string" ~/~/ Комментарий 5225 + } 5226 + ], 5227 + "cropVegetation": [ ~/~/ История вегетации поля 5228 + { 5229 + "values": [ ~/~/ Данные вегетации и состояния посева 5230 + { 5231 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5232 + "ndvi": 0 ~/~/ Индекс вегетации 5233 + } 5234 + ], 5235 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5236 + { 5237 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5238 + "type": "string", ~/~/ Тип 5239 + "pictureid": "string" ~/~/ Идентификатор ресурса 5240 + } 5241 + ], 5242 + "states": [ ~/~/ Ключевые даты развития поля 5243 + { 5244 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5245 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5246 + } 5247 + ] 5248 + } 5249 + ], 5250 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5251 + "counts": { 5252 + "fieldOperations": 0, ~/~/ Количество операций на поле 5253 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5254 + "facts": 0 ~/~/ Счётчик факта 5255 + }, 5256 + "planComment": "string", ~/~/ Комментарий к полю 5257 + "productivity": 0, ~/~/ Урожайность. 5258 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5259 +))) 5260 + 5261 +((( 5262 +((( 5263 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5264 + "year": 0, ~/~/ Год поля 5265 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5266 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5267 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5268 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5269 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5270 + "id": 0, ~/~/ Идентификатор объекта геозоны 5271 + "name": "string", ~/~/ Название объекта геозоны 5272 + "type": 0, ~/~/ Тип объекта геозоны 5273 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5274 + "fname": "string", ~/~/ Имя файла 5275 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5276 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5277 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5278 + "description": "string", ~/~/ Описание объекта геозоны 5279 + "area": 0, ~/~/ Площадь, м2 5280 + "perimetr": 0, ~/~/ Периметр, м 5281 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5282 +} 5283 +))) 5284 + 5285 + 5286 +((( 5287 +((( 5288 +((( 5289 +== **Изменение поля** == 5290 + 5291 +(% class="box infomessage" %) 5292 +((( 5293 +**PUT /api/v3/agroLands** 5294 +))) 5295 + 5296 +Пример запроса: 5297 + 5298 +((( 5299 +((( 5300 +{ 5301 + "id": 0, ~/~/ Идентификатор поля 5302 + "extId": "string", ~/~/ ExtId 5303 + "shape": "string", ~/~/ Форма поля 5304 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5305 + "display": "string", ~/~/ Настройки отображения 5306 + "year": 0, ~/~/ Год поля 5307 + "name": "string", ~/~/ Наименование 5308 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5309 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5310 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5311 + "planComment": "string", ~/~/Комментарий к полю 5312 + "cropRotations": [ ~/~/ Данные по севообороту 5313 + { 5314 + "landId": 0, ~/~/ ID поля 5315 + "landName": "string", ~/~/ Название поля 5316 + "year": 0, ~/~/ Год урожая 5317 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5318 + "cultureName": "string", ~/~/ Название культуры 5319 + "productivity": 0, ~/~/ Урожайность 5320 + "area": 0, ~/~/ Площадь поля, Га. 5321 + "total": 0, ~/~/ Валовый сбор 5322 + "productivityFact": 0, ~/~/ Фактическая урожайность 5323 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5324 + "totalFact": 0, ~/~/ Фактический валовый сбор 5325 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5326 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5327 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5328 + "isyearplan": true, 5329 + "comment": "string" ~/~/ Комментарий 5330 + } 5331 + ], 5332 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5333 +} 5334 +))) 5335 +))) 5336 + 5337 +((( 5338 + 5339 +))) 5340 + 5341 +Пример ответа: 5342 + 5343 +((( 5344 +((( 5345 +((( 5346 +{ 5347 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5348 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5349 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5350 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5351 + "cropRotations": [ ~/~/ Данные по севообороту 5352 + { 5353 + "landId": 0, ~/~/ ID поля 5354 + "landName": "string", ~/~/ Название поля 5355 + "year": 0, ~/~/ Год урожая 5356 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5357 + "cultureName": "string", ~/~/ Название культуры 5358 + "productivity": 0, ~/~/ Урожайность 5359 + "area": 0, ~/~/ Площадь поля, Га 5360 + "total": 0, ~/~/ Валовый сбор 5361 + "productivityFact": 0, ~/~/ Фактическая урожайность 5362 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5363 + "totalFact": 0, ~/~/ Фактический валовый сбор 5364 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5365 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5366 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5367 + "isyearplan": true, ~/~/ 5368 + "comment": "string" ~/~/ Комментарий 5369 + } 5370 + ], 5371 + "cropVegetation": [ ~/~/ История вегетации поля 5372 + { 5373 + "values": [ ~/~/ Данные вегетации и состояния посева 5374 + { 5375 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5376 + "ndvi": 0 ~/~/ Индекс вегетации 5377 + } 5378 + ], 5379 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5380 + { 5381 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5382 + "type": "string", ~/~/ Тип 5383 + "pictureid": "string" ~/~/ Идентификатор ресурса 5384 + } 5385 + ], 5386 + "states": [ ~/~/ Ключевые даты развития поля 5387 + { 5388 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5389 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5390 + } 5391 + ] 5392 + } 5393 + ], 5394 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5395 + "counts": { 5396 + "fieldOperations": 0, ~/~/ Количество операций на поле 5397 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5398 + "facts": 0 ~/~/ Счётчик факта 5399 + }, 5400 + "planComment": "string", ~/~/ Комментарий к полю 5401 + "productivity": 0, ~/~/ Урожайность. 5402 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5403 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5404 + "year": 0, ~/~/ Год поля 5405 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5406 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5407 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5408 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5409 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5410 + "id": 0, ~/~/ Идентификатор объекта геозоны 5411 + "name": "string", ~/~/ Название объекта геозоны 5412 + "type": 0, ~/~/ Тип объекта геозоны 5413 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5414 + "fname": "string", ~/~/ Имя файла 5415 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5416 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5417 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5418 + "description": "string", ~/~/ Описание объекта геозоны 5419 + "area": 0, ~/~/ Площадь, м2 5420 + "perimetr": 0, ~/~/ Периметр, м 5421 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5422 +} 5423 +))) 5424 +))) 5425 +))) 5426 +))) 5427 +))) 5428 + 5429 + 5430 +== **Редактирование года урожая ** == 5431 + 5432 +(% class="box successmessage" %) 5433 +((( 5434 +**POST /api/v3/agroLands/updateOpenCloseYear** 5435 +))) 5436 + 5437 +Пример запроса: 5438 + 5439 +((( 5440 +((( 5441 +{ 5442 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5443 + 0 5444 + ], 5445 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5446 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5447 +} 5448 +))) 5449 + 5450 + 5451 +))) 5452 + 5453 +Пример ответа: 5454 + 5455 +((( 5456 +((( 5457 +{ 5458 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5459 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5460 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5461 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5462 + "cropRotations": [ ~/~/ Данные по севообороту 5463 + { 5464 + "landId": 0, ~/~/ ID поля 5465 + "landName": "string", ~/~/ Название поля 5466 + "year": 0, ~/~/ Год урожая 5467 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5468 + "cultureName": "string", ~/~/ Название культуры 5469 + "productivity": 0, ~/~/ Урожайность 5470 + "area": 0, ~/~/ Площадь поля, Га. 5471 + "total": 0, ~/~/ Валовый сбор 5472 + "productivityFact": 0, ~/~/ Фактическая урожайность 5473 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5474 + "totalFact": 0, ~/~/ Фактический валовый сбор 5475 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5476 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5477 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5478 + "isyearplan": true, ~/~/ 5479 + "comment": "string" ~/~/ Комментарий 5480 + } 5481 + ], 5482 + "cropVegetation": [ ~/~/ История вегетации поля 5483 + { 5484 + "values": [ ~/~/ Данные вегетации и состояния посева 5485 + { 5486 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5487 + "ndvi": 0 ~/~/ Индекс вегетации 5488 + } 5489 + ], 5490 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5491 + { 5492 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5493 + "type": "string", ~/~/ Тип 5494 + "pictureid": "string" ~/~/ Идентификатор ресурса 5495 + } 5496 + ], 5497 + "states": [ ~/~/ Ключевые даты развития поля 5498 + { 5499 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5500 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5501 + } 5502 + ] 5503 + } 5504 + ], 5505 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5506 + "counts": { 5507 + "fieldOperations": 0, ~/~/ Количество операций на поле 5508 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5509 + "facts": 0 ~/~/ Счётчик факта 5510 + }, 5511 + "planComment": "string", ~/~/ Комментарий к полю 5512 + "productivity": 0, ~/~/ Урожайность. 5513 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5514 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5515 + "year": 0, ~/~/ Год поля 5516 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5517 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5518 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5519 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5520 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5521 + "id": 0, ~/~/ Идентификатор объекта геозоны 5522 + "name": "string", ~/~/ Название объекта геозоны 5523 + "type": 0, ~/~/ Тип объекта геозоны 5524 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5525 + "fname": "string", ~/~/ Имя файла 5526 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5527 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5528 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5529 + "description": "string", ~/~/ Описание объекта геозоны 5530 + "area": 0, ~/~/ Площадь, м2 5531 + "perimetr": 0, ~/~/ ериметр, м 5532 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5533 +} 5534 + 5535 + 5536 +== **Какие поля посещал объект** == 5537 + 5538 +(% class="box successmessage" %) 5539 +((( 5540 +**POST /api/v3/agroLands/visitingByVehicle** 5541 +))) 5542 + 5543 +Пример запроса: 5544 + 5545 +{ 5546 + "vehicleId": 0, ~/~/ id объекта 5547 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5548 + "byTime": 0, ~/~/ Объединение событий по времени 5549 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5550 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5551 + "from": "2025-07-29T12:20:28.815Z", ~/~/ Начало периода (локальное время клиента) 5552 + "to": "2025-07-29T12:20:28.815Z", ~/~/ Конец периода (локальное время клиента) 5553 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5554 +} 5555 + 5556 +Пример ответа: 5557 + 5558 +[ 5559 + { 5560 + "fieldId": 0, ~/~/ id объекта 5561 + "vehicleName": "string", ~/~/ Наименование объекта 5562 + "fieldName": "string", ~/~/ Наименование поля 5563 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5564 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5565 + "vehicleId": 0, ~/~/ Идентификатор ТС 5566 + "start": "2025-07-29T12:20:28.855Z", ~/~/ Начало посещения 5567 + "end": "2025-07-29T12:20:28.855Z", ~/~/ Конец посещения 5568 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5569 + "mileage": 0 ~/~/ Пробег 5570 + } 5571 +] 5572 +))) 5573 + 5574 + 5575 +== **Посещение поля объектами ** == 5576 + 5577 +(% class="box successmessage" %) 5578 +((( 5579 +**POST /api/v3/agroLands/visitingByField** 5580 +))) 5581 + 5582 +Пример запроса: 5583 +{ 5584 + "fieldId": 0, ~/~/ ID поля 5585 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 5586 + "byTime": 0, ~/~/ Объединение событий по времени 5587 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 5588 + "byDist": 0, ~/~/ Объединение событий по расстоянию 5589 + "from": "2025-07-29T11:44:28.218Z", ~/~/ Начало периода (локальное время клиента) 5590 + "to": "2025-07-29T11:44:28.218Z", ~/~/ Конец периода (локальное время клиента) 5591 + "timezone": 0 ~/~/ Таймзона клиента, в часах. Если не передана - то считается как +3, MSK 5592 +} 5593 + 5594 +Пример ответа: 5595 + 5596 +[ 5597 + { 5598 + "fieldId": 0, ~/~/ ID поля 5599 + "vehicleName": "string", ~/~/ Наименование объекта 5600 + "fieldName": "string", ~/~/ Имя поля 5601 + "fuelUsage": 0, ~/~/ Расход топлива, л/га 5602 + "area": 0, ~/~/ Пройдено, га (информация из встроенного агрегата в модели объекта при наличии агрегата) 5603 + "vehicleId": 0, ~/~/ Идентификатор ТС 5604 + "start": "2025-07-29T11:44:28.219Z", ~/~/ Начало посещения 5605 + "end": "2025-07-29T11:44:28.219Z", ~/~/ Конец посещения 5606 + "durationSeconds": 0, ~/~/ Продолжительность посещения внутри поля 5607 + "mileage": 0 ~/~/ Пробег 5608 + } 5609 +] 5610 + 5611 + 5612 +== **Удаление существующего поля** == 5613 + 5614 +(% class="box errormessage" %) 5615 +((( 5616 +**DELETE /api/v3/agroLands/{id}** 5617 +))) 5618 + 5619 +Пример запроса: 5620 +id ~/~/ Идентификатор поля 5621 + 5622 +Пример ответа: 5623 + 5624 +((( 5625 +200 ~/~/ Успех 5626 + 5627 + 5628 +))) 5629 + 5630 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5631 +))) 5632 +))) 5633 +))) 5634 + 5635 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5636 + 5637 + 5638 +(% class="box infomessage" %) 5639 +((( 5640 +**GET api/v3/Vehicles/recyclebin/all** 5641 +))) 5642 + 5643 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5644 + 5645 +Параметр запроса: {parentId} - идентификатор агента 5646 + 5647 +В заголовках запроса: X-Auth: Токен авторизации 5648 + 5649 +Ответ: 5650 + 5651 +[ 5652 + { 5653 + "recordTime": "", ~/~/Время записи 5654 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5655 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5656 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5657 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5658 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5659 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5660 + "items": [ ~/~/ 5661 +nullable: true ~/~/Детали 5662 + { 5663 + "name": "string", ~/~/наименование столбца 5664 + "value": "string" ~/~/содержание столбца 5665 + } 5666 + ] 5667 + }, 5668 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5669 + "string" 5670 + ] 5671 + } 5672 +] 5673 + 5674 + 5675 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5676 + 5677 +(% class="box infomessage" %) 5678 +((( 5679 +**POST api/v3/Vehicles/recyclebin/erase** 5680 +))) 5681 + 5682 +В заголовках запроса: X-Auth: Токен авторизации 5683 + 5684 +Пример запроса: 5685 + 5686 +[ 5687 +0 5688 +] 5689 + 5690 + 5691 +Пример ответа: 5692 + 5693 +[ 5694 +{ 5695 + "recordTime": "", ~/~/Время записи 5696 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5697 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5698 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5699 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5700 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5701 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5702 + "items": [ ~/~/Детали 5703 + { 5704 + "name": "", ~/~/Имя свойства 5705 + "value": "" ~/~/Значение свойства 5706 + } 5707 + ] 5708 + }, 5709 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5710 + "" 5711 + ] 5712 + } 5713 +] 5714 + 5715 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5716 + 5717 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5718 + 5719 +(% class="box infomessage" %) 5720 +((( 5721 +**POST api/v3/Vehicles/recyclebin/restore** 5722 +))) 5723 + 5724 +В заголовках запроса: X-Auth: Токен авторизации 5725 + 5726 +Параметры в теле запроса (JSON): 5727 + 5728 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5729 + 5730 +В заголовках запроса: X-Auth: Токен авторизации 5731 + 5732 + 5733 +Пример запроса: 5734 + 5735 +((( 5736 +[ 5737 +))) 5738 + 5739 +((( 5740 + 0 5741 +))) 5742 + 5743 +((( 5744 +] 5745 +))) 5746 + 5747 + 5748 +Пример ответа: 5749 + 5750 +[ 5751 +{ 5752 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5753 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5754 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5755 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5756 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5757 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5758 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5759 + "items": [ ~/~/Детали 5760 + { 5761 + "name": "string", ~/~/Имя свойства 5762 + "value": "string" ~/~/Значение свойства 5763 + } 5764 + ] 5765 + }, 5766 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5767 + "string" 5768 + ] 5769 + } 5770 +] 5771 + 5772 + 5773 += **Раздел: Журнал заданий ** = 5774 + 5775 + 5776 +== **Создание задания в Журнале заданий** == 5777 + 5778 +(% class="box infomessage" %) 5779 +((( 5780 +**POST /api/v3/vehicletasks** 5781 +))) 5782 + 5783 +Пример запроса: 5784 + 5785 +((( 5786 +{ 5787 + "vehicleId": 0, ~/~/ Идентификатор ТС 5788 + "description": "string", ~/~/ Описание 5789 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5790 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5791 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5792 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5793 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5794 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5795 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5796 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5797 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5798 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5799 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5800 + "cost": { 5801 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5802 + "Name": "string", ~/~/ Наименование 5803 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5804 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5805 + "Norm": 0 ~/~/ Норма внесения 5806 + }, 5807 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5808 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5809 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5810 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5811 + "deleted": true, ~/~/ Признак удаления 5812 + "extId": "string", 5813 + "GeoIds": [ ~/~/ Cвязанные поля 5814 + 0 5815 + ] 5816 +} 5817 +))) 5818 + 5819 + 5820 +Пример ответа: 5821 + 5822 +{ 5823 + "vehicleId": 0, ~/~/ Идентификатор ТС 5824 + "description": "string", ~/~/ Описание 5825 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5826 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5827 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5828 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5829 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5830 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5831 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5832 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5833 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5834 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5835 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5836 + "cost": { 5837 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5838 + "Name": "string", ~/~/ Наименование 5839 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5840 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5841 + "Norm": 0 ~/~/ Норма внесения 5842 + }, 5843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5844 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5845 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5846 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5847 + "deleted": true, ~/~/ Признак удаления 5848 + "extId": "string", ~/~/ ExtId 5849 + "GeoIds": [ ~/~/ Связанные поля 5850 + 0 5851 + ] 5852 +} 5853 + 5854 + 5855 +== **Редактирование задания в Журнале заданий** == 5856 + 5857 +(% class="box successmessage" %) 5858 +((( 5859 +**PUT /api/v3/vehicletasks** 5860 +))) 5861 + 5862 +Пример запроса: 5863 + 5864 +((( 5865 +{ 5866 + "vehicleId": 0, ~/~/ Идентификатор ТС 5867 + "description": "string", ~/~/ Описание 5868 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5869 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5870 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5871 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5872 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5873 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5874 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5875 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5876 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5877 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5878 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5879 + "cost": { 5880 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5881 + "Name": "string", ~/~/ Наименование 5882 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5883 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5884 + "Norm": 0 ~/~/ Норма внесения 5885 + }, 5886 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5887 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5888 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5889 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5890 + "deleted": true, ~/~/ Признак удаления 5891 + "extId": "string", ~/~/ ExtId 5892 + "GeoIds": [ ~/~/ Связанные поля 5893 + 0 5894 + ] 5895 +} 5896 +))) 5897 + 5898 + 5899 +Пример ответа: 5900 + 5901 +{ 5902 + "vehicleId": 0, ~/~/ Идентификатор ТС 5903 + "description": "string", ~/~/ Описание 5904 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5905 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5906 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5907 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5908 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5909 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5910 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5911 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5912 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5913 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5914 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5915 + "cost": { 5916 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5917 + "Name": "string", ~/~/ Наименование 5918 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5919 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5920 + "Norm": 0 ~/~/ Норма внесения 5921 + }, 5922 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5923 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5924 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5925 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5926 + "deleted": true, ~/~/ Признак удаления 5927 + "extId": "string", ~/~/ ExtId 5928 + "GeoIds": [ ~/~/ Связанные поля 5929 + 0 5930 + ] 5931 +} 5932 + 5933 + 5934 +== **Удаление задания в Журнале заданий** == 5935 + 5936 +(% class="box warningmessage" %) 5937 +((( 5938 +**DELETE /api/v3/vehicletasks** 5939 +))) 5940 + 5941 +Пример запроса: 5942 + 5943 +((( 5944 +[ 5945 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5946 +] 5947 +))) 5948 + 5949 +((( 5950 + 5951 +))) 5952 + 5953 +Пример ответа: 5954 + 5955 +{ 5956 + "vehicleId": 0, ~/~/ Идентификатор ТС 5957 + "description": "string", ~/~/ Описание 5958 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5959 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5960 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5961 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5962 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5963 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5964 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5965 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5966 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5967 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5968 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5969 + "cost": { 5970 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5971 + "Name": "string", ~/~/ Наименование 5972 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5973 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5974 + "Norm": 0 ~/~/ Норма внесения 5975 + }, 5976 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5977 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5978 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5979 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5980 + "deleted": true, ~/~/ Признак удаления 5981 + "extId": "string", ~/~/ ExtId 5982 + "GeoIds": [ ~/~/ Связанные поля 5983 + 0 5984 + ] 5985 +} 5986 + 5987 + 5988 +== **Получение списка Журнала заданий** == 5989 + 5990 +(% class="box infomessage" %) 5991 +((( 5992 +**POST /api/v3/vehicletasks/getbyperiod** 5993 +))) 5994 + 5995 +Пример запроса: 5996 + 5997 +((( 5998 +{ 5999 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6000 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6001 + "TimeZone": 0, ~/~/ Часовой пояс. 6002 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6003 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6004 + ], 6005 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6006 + 0 6007 + ], 6008 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6009 + 0 6010 + ], 6011 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6012 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6013 +} 6014 +))) 6015 + 6016 + 6017 +Пример ответа: 6018 + 6019 +((( 6020 +{ 6021 + "total": 0, ~/~/ Общее количество записей 6022 + "pages": 0, ~/~/ Общее количество страниц 6023 + "currentPage": 0, ~/~/ Текущая страница 6024 + "items": [ ~/~/ Записи 6025 + { 6026 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6027 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6028 + "name": "string", ~/~/ Название задания. 6029 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6030 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6031 + "workKind": "string", ~/~/ Вид работ 6032 + "techOp": "string", ~/~/ Тех. операция 6033 + "trailerModel": "string", ~/~/ Модель агрегата 6034 + "width": "string", ~/~/ Ширина, м 6035 + "speed": "string", ~/~/ Тех. скорость 6036 + "fields": "string", ~/~/ Поля 6037 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6038 + "vehicles": "string", ~/~/ Объект-модель 6039 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6040 + "drivers": "string", ~/~/ Водители 6041 + "tmc": "string", ~/~/ ТМЦ 6042 + "client": "string", ~/~/ Клиент 6043 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6044 + "dep": "string", ~/~/ Подразделение 6045 + "geoIds": [ ~/~/ Связанные поля 6046 + 0 6047 + ] 6048 + } 6049 + ] 6050 +} 6051 +))) 6052 + 6053 + 6054 += **Раздел: Роли** = 6055 + 6056 +== **Получение списка клиентских и системных ролей пользователя ** == 6057 + 6058 +(% class="box successmessage" %) 6059 +((( 6060 +**POST /api/v3/groups/find** 6061 +))) 6062 + 6063 +Пример запроса: 6064 + 6065 +((( 6066 +{ 6067 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6068 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6069 +} 6070 +))) 6071 + 6072 +((( 6073 + 6074 +))) 6075 + 6076 +((( 6077 +Пример ответа: 6078 +))) 6079 + 6080 +((( 6081 +((( 6082 +{ 6083 + "groups": [ ~/~/ Системные роли пользователя 6084 + { 6085 + "code": "string", ~/~/ Код роли. 6086 + "name": "string", ~/~/ Имя 6087 + "shortName": "string" ~/~/ Короткое имя 6088 + } 6089 + ], 6090 + "customGroups": [ ~/~/ Системные роли пользователя 6091 + { 6092 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6093 + "name": "string", ~/~/ Наименование 6094 + "shortName": "string", ~/~/ Короткое наименование 6095 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6096 + } 6097 + ] 6098 +} 6099 +))) 6100 +))) 6101 + 6102 +((( 6103 + 6104 +))) 6105 + 6106 +((( 6107 + 6108 +))) 6109 + 6110 += **Раздел: Локатор ** = 6111 + 6112 + 6113 +== **Получение данных по локатору** == 6114 + 6115 +(% class="box infomessage" %) 6116 +((( 6117 +**GET /api/v3/locators/{locatorId}** 6118 +))) 6119 + 6120 +В запросе указывается locatorid - идентификатор локатора 6121 + 6122 + 6123 +Пример ответа: 6124 + 6125 +((( 6126 +((( 6127 +{ 6128 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6129 + 0 6130 + ], 6131 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6132 + 0 6133 + ], 6134 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6135 + 0 6136 + ], 6137 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6138 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6139 + "agentName": "string", ~/~/ Наименование агента. 6140 + "isEnabled": true, ~/~/ Активность 6141 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6142 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6143 + "name": "string", ~/~/ Наименование. 6144 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6145 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6146 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6147 + "validity": 0, ~/~/ Значение срока действия 6148 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6149 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6150 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6151 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6152 + "url": "string", ~/~/ Ссылка 6153 + "language": 0, ~/~/ ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6154 + 6155 + "showVehicleName": true, ~/~/ Наименование объекта 6156 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6157 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6158 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6159 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6160 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6161 + 6162 + 1 6163 + 6164 + ] 6165 +} 6166 +))) 6167 +))) 6168 + 6169 + 6170 +((( 6171 +((( 6172 + 6173 +))) 6174 +))) 6175 + 6176 + 6177 +== **Создание локатора** == 6178 + 6179 +(% class="box successmessage" %) 6180 +((( 6181 +**POST /api/v3/locators** 6182 +))) 6183 + 6184 +Пример запроса: 6185 + 6186 +((( 6187 +{ 6188 + "isEnabled": true, ~/~/ Активность 6189 + "name": "string", ~/~/ Наименование локатора 6190 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6191 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6192 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6193 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6194 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6195 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6196 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6197 + 0 6198 + ], 6199 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6200 + 0 6201 + ], 6202 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6203 + 0 6204 + ], 6205 + 6206 + "showVehicleName": true, ~/~/ Наименование объекта 6207 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6208 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6209 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6210 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6211 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6212 + 6213 + 1 6214 + 6215 + ] 6216 +} 6217 +))) 6218 + 6219 + 6220 +Пример ответа: 6221 + 6222 +((( 6223 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6224 +))) 6225 + 6226 + 6227 +== **Выводит список локаторов ** == 6228 + 6229 +(% class="box successmessage" %) 6230 +((( 6231 +**POST /api/v3/locators/find** 6232 +))) 6233 + 6234 +Пример запроса: 6235 + 6236 +((( 6237 +{ 6238 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор клиента 6239 +} 6240 +))) 6241 + 6242 +((( 6243 + 6244 +))) 6245 + 6246 +((( 6247 + 6248 +))) 6249 + 6250 + 6251 +Пример ответа: 6252 + 6253 +((( 6254 +[ 6255 + { 6256 + "vehiclesCount": 0, ~/~/ Количество объектов. 6257 + "geozonesCount": 0, ~/~/ Количество геозон. 6258 + "fieldsCount": 0, ~/~/ Количество полей. 6259 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6260 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 6261 + "agentName": "string", ~/~/ Наименование агента. 6262 + "isEnabled": true, ~/~/ Активность локатора 6263 + "created": "2025-07-03T12:57:58.738Z", ~/~/ Дата создания 6264 + "updated": "2025-07-03T12:57:58.738Z", ~/~/ Дата обновления 6265 + "name": "string", ~/~/ Наименование локатора 6266 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6267 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6268 + "activationTime": "2025-07-03T12:57:58.738Z", ~/~/ Дата и время активации правила (UTC) 6269 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6270 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6271 + "autoProlongation": true, ~/~/ Автоматическая пролонгация 6272 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6273 + "creatorUserName": "string", ~/~/ Наименование пользователя создавшего локатора 6274 + "url": "string", ~/~/ ссылка на локатор 6275 + "language": 1, ~/~/ Язык локатора(1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6276 + "showVehicleName": true, ~/~/ Наименование объекта 6277 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6278 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6279 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6280 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6281 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6282 + 6283 + 0 6284 + ] 6285 + } 6286 +] 6287 +))) 6288 + 6289 + 6290 +== **Изменение локатора** == 6291 + 6292 +(% class="box infomessage" %) 6293 +((( 6294 +**PUT /api/v3/locators** 6295 +))) 6296 + 6297 +Пример запроса: 6298 + 6299 +((( 6300 +{ 6301 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6302 + "isEnabled": true, ~/~/ Активность 6303 + "name": "string", ~/~/ Наименование 6304 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6305 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6306 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6307 + "autoProlongation": true, ~/~/ Автопродление срока действия 6308 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6309 + "vehiclesIds": [ ~/~/ ID объектов отображающихся в локаторе, записываются через запятую 6310 + 0 6311 + ], 6312 + "geoIds": [ ~/~/ ID геозон отображающихся в локаторе, записываются через запятую 6313 + 0 6314 + ], 6315 + "fieldsIds": [ ~/~/ ID полей отображающихся в локаторе, записываются через запятую 6316 + 0 6317 + ], 6318 + "showVehicleName": true, ~/~/ Наименование объекта 6319 + "showVehicleDirection": true, ~/~/ Показывать направление движения объекта на карте 6320 + "allowTrackReport": true, ~/~/ отображение колонки и кнопок **Построить историю за сутки** 6321 + "showTrackTracing": true, ~/~/ Отображение трассировки трека на карте по ссылке. 6322 + "showSensors": true, ~/~/ Отображение заведенных датчиков на объектах 6323 + "availableMapLayers": [ ~/~/Слои на карте ,по умолчанию OpenStreetMap (1-OpenStreetMap, 2-Yandex (Карта), 3-Yandex (Спутник), 4-Yandex (Гибрид), 5-Yandex (Пробки), 6-Google (Карта), 7-Google (Гибрид), 8-Google (Рельеф), 9-Google (Спутник), 10-Bing (Карта), 11-Bing (Гибрид), 12-Bing(Темная карта), 13-2ГИС) 6324 + 6325 + 0 6326 + 6327 + ] 6328 +} 6329 + 6330 + 6331 +))) 6332 + 6333 +Пример ответа: 6334 + 6335 +200 ~/~/ Success 6336 + 6337 + 6338 +== **Удалить локатор** == 6339 + 6340 +(% class="box warningmessage" %) 6341 +((( 6342 +**DELETE /api/v3/locators** 6343 +))) 6344 + 6345 +Пример запроса: 6346 + 6347 +((( 6348 +[ 6349 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6350 +] 6351 +))) 6352 + 6353 + 6354 += **Раздел: Яндекс Маршруты** = 6355 + 6356 + 6357 +== **Возвращение списка маршрутов** == 6358 + 6359 +(% class="box infomessage" %) 6360 +((( 6361 +**GET /api/v3/TransportRoutes** 6362 +))) 6363 + 6364 +Пример запроса: 6365 +Id ~/~/ Идентификатор поля 6366 + 6367 +Пример ответа: 6368 + 6369 +((( 6370 +[ 6371 + { 6372 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6373 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6374 + "name": "string", ~/~/ Наименование маршрута. 6375 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6376 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6377 + 0 6378 + ] 6379 + } 6380 +] 6381 +))) 6382 + 6383 + 6384 +== **Добавить маршрут** == 6385 + 6386 +(% class="box infomessage" %) 6387 +((( 6388 +**POST /api/v3/TransportRoutes** 6389 +))) 6390 + 6391 +Пример запроса: 6392 +{ 6393 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6394 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6395 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6396 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6397 + 0 6398 + ] 6399 +} 6400 + 6401 + 6402 +Пример ответа: 6403 + 6404 +((( 6405 +{ 6406 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6407 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6408 + "name": "string", ~/~/ Определяет наименование маршрута 6409 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6410 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6411 + 0 6412 + ] 6413 +} 6414 +))) 6415 + 6416 + 6417 +== **Обновление маршрута** == 6418 + 6419 +(% class="box successmessage" %) 6420 +((( 6421 +**PUT /api/v3/TransportRoutes** 6422 +))) 6423 + 6424 +Пример запроса: 6425 + 6426 +((( 6427 +{ 6428 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6429 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6430 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6431 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6432 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6433 + 0 6434 + ] 6435 +} 6436 +))) 6437 + 6438 +Пример ответа: 6439 + 6440 +((( 6441 +{ 6442 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6443 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6444 + "name": "string", ~/~/ Определяет наименование маршрута 6445 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6446 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6447 + 0 6448 + ] 6449 +} 6450 +))) 6451 + 6452 + 6453 +== **Получить связки маршрутов ТС** == 6454 + 6455 +(% class="box infomessage" %) 6456 +((( 6457 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6458 +))) 6459 + 6460 +Пример запроса: 6461 + 6462 +((( 6463 +[ 6464 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6465 +] 6466 +))) 6467 + 6468 +Пример ответа: 6469 + 6470 +((( 6471 +[ 6472 + { 6473 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6474 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6475 + } 6476 +] 6477 +))) 6478 + 6479 + 6480 +== **Удалить маршрут** == 6481 + 6482 +(% class="box warningmessage" %) 6483 +((( 6484 +**DELETE /api/v3/TransportRoutes/{id}** 6485 +))) 6486 + 6487 +Пример запроса: 6488 +Id ~/~/ Идентификатор поля 6489 + 6490 + 6491 += **Раздел: Управление доступа к машинам** = 6492 + 6493 + 6494 +== Получение списка транспортных средств видимых пользователю == 6495 + 6496 +(% class="box infomessage" %) 6497 +((( 6498 +**GET /api/v3/UserVisibleVehicles/{userId}** 6499 +))) 6500 + 6501 +Пример ответа: 6502 + 6503 +((( 6504 +{ 6505 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6506 + 0 6507 + ] 6508 +} 6509 +))) 6510 + 6511 + 6512 +== Задает видимость транспортных средств пользователю == 6513 + 6514 +(% class="box infomessage" %) 6515 +((( 6516 +**POST /api/v3/UserVisibleVehicles** 6517 +))) 6518 + 6519 +Пример запроса: 6520 + 6521 +((( 6522 +((( 6523 +{ 6524 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6525 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6526 + 0 6527 + ] 6528 +} 6529 +))) 6530 + 6531 +((( 6532 + 6533 +))) 6534 + 6535 +((( 6536 +Пример ответа : 6537 +))) 6538 + 6539 +((( 6540 + 6541 +))) 6542 + 6543 +((( 6544 +200 ~/~/ Success 6545 +))) 6546 +))) 6547 + 6548 + 1408 1408 (% class="box" lang="en-US" style="text-align: center;" %) 1409 1409 ((( 1410 1410 (% 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