Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/08/08 13:28
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 { ... ... @@ -217,6 +217,28 @@ 217 217 "bankKS": "string" ~/~/ корр. счёт 218 218 } 219 219 290 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 291 +|(% style="width:215px" %)(% style="color:#000000" %)agentId|(% style="width:861px" %)(% style="color:#000000" %)Идентификатор клиента 292 +|(% style="width:215px" %)parentId|(% style="width:861px" %)Идентификатор клиента-родителя 293 +|(% style="width:215px" %)parentName|(% style="width:861px" %)Наименование (% style="color:#000000" %)клиента-родителя 294 +|(% style="width:215px" %)name|(% style="width:861px" %)(% style="color:#000000" %)Наименование клиента 295 +|(% style="width:215px" %)fullName|(% style="width:861px" %)(% style="color:#000000" %)Полное наименование клиента 296 +|(% style="width:215px" %)agentInfoType|(% style="width:861px" %)(% style="color:#000000" %)Тип клиента (0- Клиент, 1 - Партнер, 2 - Группа, 3 - Административная группа, 4 - Тестовый клиент, 5 - Договор) 297 +|(% style="width:215px" %)isForeign|(% style="width:861px" %)Иностранный контрагент 298 +|(% style="width:215px" %)district|(% style="width:861px" %)Округ 299 +|(% style="width:215px" %)region|(% style="width:861px" %)Регион 300 +|(% style="width:215px" %)city|(% style="width:861px" %)Город 301 +|(% style="width:215px" %)inn|(% style="width:861px" %)ИНН клиента 302 +|(% style="width:215px" %)kpp|(% style="width:861px" %)КПП клиента 303 +|(% style="width:215px" %)address|(% style="width:861px" %)Юридический адрес 304 +|(% style="width:215px" %)addressFact|(% style="width:861px" %)Фактический адрес 305 +|(% style="width:215px" %)email|(% style="width:861px" %)Электронная почта 306 +|(% style="width:215px" %)director|(% style="width:861px" %)ФИО руководителя 307 +|(% style="width:215px" %)bankName|(% style="width:861px" %)Банк 308 +|(% style="width:215px" %)bankBIK|(% style="width:861px" %)БИК 309 +|(% style="width:215px" %)bankRS|(% style="width:861px" %)Номер счета 310 +|(% style="width:215px" %)bankKS|(% style="width:861px" %)Корр. счет 311 + 220 220 == (% style="color:#000000; font-size:16px" %)**Редактирование клиента**(%%) == 221 221 222 222 (% class="box warningmessage" %) ... ... @@ -232,7 +232,6 @@ 232 232 233 233 В заголовках запроса: X-Auth: Токен авторизации 234 234 235 - 236 236 Параметры в теле запроса (JSON): 237 237 238 238 { ... ... @@ -257,7 +257,6 @@ 257 257 "bankKS": "string" ~/~/ корр. счёт 258 258 } 259 259 260 - 261 261 Ответ: 262 262 263 263 { ... ... @@ -300,6 +300,21 @@ 300 300 301 301 Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 302 302 393 +== (% style="color:#000000; font-size:16px" %)**Смена статуса клиента (активация/блокировка)**(%%) == 394 + 395 +(% class="box warningmessage" %) 396 +((( 397 +**PUT /api/v3/agents/{id}/changeStatus/{status}** 398 +))) 399 + 400 +Метод позволяет изменить статус клиента, указанного в запросе. 401 + 402 +В пути указывается GUID клиента и статус клиента. 403 + 404 +**status **- значение 0 - заблокирован, 1 - активен. 405 + 406 +Ответ: Code 204 407 + 303 303 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Пользователи**(%%) = 304 304 305 305 == (% style="color:#000000; font-size:16px" %)**Добавление пользователя**(%%) == ... ... @@ -351,7 +351,6 @@ 351 351 ], 352 352 "language": 0 ~/~/ Язык интерфейса пользователя 1 - Русский, 2 - Английский, 3 - Азербайджанский 353 353 } 354 - 355 355 { 356 356 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 357 357 "lastName": "string", ... ... @@ -363,15 +363,10 @@ 363 363 "password": "string", 364 364 "email": "string", 365 365 366 - 367 367 (% style="text-align:left" %) 368 368 (% style="color:#000000; font-weight:normal" %)Ответ: 369 - 370 -(% style="text-align:left" %) 371 -(% style="color:#000000; font-weight:normal" %){ 372 - 373 -(% style="text-align:left" %) 374 -(% style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 472 +{ 473 + "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" %), ~/~/ роли пользователя, перечислены названия групп пользователя 490 +} 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 - 512 +(% style="color:#000000" %){(%%) 416 416 "parentId": "375a1f06-c384-43f8-8562-1c3d79a32303", ~/~/ GUID агента, для которого надо получить данные, null - для текущего агента 417 417 "userId": "11111111-c384-43f8-8562-1c3d79a32303", ~/~/ ID пользователя, по которому фильтруется, null - неважно 418 418 "login": "qqqqqq", ~/~/ Логин пользователя, по которому фильтруется, null - неважно 419 419 "email": "eee", ~/~/ Email пользователя, по которому фильтруется, null - неважно 420 - 421 421 (% style="color:#000000" %)} 422 422 423 423 (% style="color:#000000" %)Ответ: 424 424 425 425 (% style="color:#000000" %){ (%%) 426 - 427 427 "id": "" , ~/~/ идентификатор пользователя 428 428 "lastName": "" , ~/~/ фамилия 429 429 "firstName": "" , ~/~/ имя ... ... @@ -437,7 +437,6 @@ 437 437 "sessionDuration":"", ~/~/ длительность сессии в минутах 438 438 "status": "1", ~/~/ статус пользователя 439 439 "lastLogged": "", ~/~/ дата/время последней авторизации 440 - 441 441 (% style="color:#000000" %)} 442 442 443 443 == (% style="color:#000000; font-size:16px" %)**Получение информации о пользователе**(%%) == ... ... @@ -511,10 +511,8 @@ 511 511 (% lang="ru-RU" style="color:#000000; font-weight:normal" %)Параметры в теле запроса (JSON): 512 512 513 513 (% lang="en-US" style="text-align:left" %) 514 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 515 - 516 -(% lang="en-US" style="text-align:left" %) 517 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %) "id": "" , ~/~/ ID пользователя 608 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 609 + "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" %) 631 + "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": "" , ~/~/ идентификатор пользователя 638 +(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 639 + "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» названия группы пользователя 660 +} 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 - 681 +(% 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 - 706 + "8ed730d3-c61c-4c3a-ae4f-f41d9e710abc", 623 623 "415f9ea3-8bc0-4e87-8d78-0852b0c0a4f1" 624 624 ] 625 625 ... ... @@ -682,8 +682,251 @@ 682 682 (% style="text-align:left" %) 683 683 (% style="color:#000000" %)**Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200».** 684 684 685 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: ** Транспортныесредства**(%%) =769 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Модель объекта**(%%) = 686 686 771 +== (% style="color:#000000; font-size:16px" %)**Получение информации о модели объекта**(%%) == 772 + 773 +(% class="box infomessage" %) 774 +((( 775 +(% lang="en-US" %)**GET /api/v3/models/{Id}** 776 +))) 777 + 778 +Метод возвращает полную информацию о модели объекта. 779 + 780 +(% style="color:#000000" %)Метод запроса: **GET** 781 + 782 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/(% lang="en-US" %)v3/models/(% style="color:#000000" %){(%%)ID} 783 + 784 +(% style="color:#000000" %)Параметр запроса: {__**id}**__ - идентификатор модели объекта 785 + 786 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 787 + 788 +(% style="color:#000000" %)Ответ: 789 + 790 +(% style="color:#000000" %){ 791 + "parentName": "string", 792 + "name": "string", 793 + "picture": "string", 794 + "minspeed": 0, 795 + "maxspeed": 0, 796 + "width": 0, 797 + "imbeddedtrailer": true, 798 + "hoppercapacity": 0, 799 + "hopperdischargespeed": 0, 800 + "modelType": 0, 801 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 802 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 803 + "deleted": true 804 +} 805 + 806 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 807 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 808 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 809 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 810 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 811 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 812 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 813 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 814 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 815 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 816 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 817 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 818 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 819 +|(% style="width:215px" %)(% style="color:#000000" %)deleted|(% style="width:861px" %)Признак удаления, тип: boolean 820 + 821 +== (% style="color:#000000; font-size:16px" %)**Просмотр списка моделей**(%%) == 822 + 823 +(% class="box successmessage" %) 824 +((( 825 +(% lang="en-US" %)**POST /api/v3/models/find** 826 +))) 827 + 828 +(% style="color:#000000" %)Метод позволяет получить список всех моделей клиента, указанного в запросе. 829 + 830 +(% style="color:#000000" %)Метод запроса: **POST** 831 + 832 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/models/find 833 + 834 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 835 + 836 +(% style="color:#000000" %)Параметры в теле запроса (JSON):{ 837 + 838 +(% style="color:#000000" %) "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 839 +} 840 + 841 +(% style="color:#000000" %)Ответ: 842 + 843 +(% style="color:#000000" %)[ 844 + { 845 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 846 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 847 + "parentName": "string", 848 + "name": "string", 849 + "modelType": 0 850 + } 851 +] 852 + 853 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 854 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 855 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 856 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 857 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 858 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 859 + 860 +== (% style="color:#000000; font-size:16px" %)**Добавление модели**(%%) == 861 + 862 +(% class="box successmessage" %) 863 +((( 864 +(% lang="en-US" %)**POST /api/v3/models** 865 +))) 866 + 867 +(% style="color:#000000" %)Метод позволяет добавить объект, указанный в запросе. 868 + 869 +(% style="color:#000000" %)Метод запроса: **POST** 870 + 871 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/(% lang="en-US" %)models 872 + 873 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 874 + 875 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 876 + 877 +{ 878 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 879 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 880 + "deleted": false, 881 + "extId": "string", 882 + "name": "string", 883 + "picture": "string", 884 + "minspeed": 0, 885 + "maxspeed": 0, 886 + "width": 0, 887 + "imbeddedtrailer": true, 888 + "fueloutlay": 0, 889 + "hoppercapacity": 0, 890 + "hopperdischargespeed": 0, 891 + "modelType": 0 892 +} 893 + 894 +Ответ: 895 + 896 +{ 897 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 898 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 899 + "deleted": false, 900 + "extId": "string", 901 + "name": "string", 902 + "picture": "string", 903 + "minspeed": 0, 904 + "maxspeed": 0, 905 + "width": 0, 906 + "imbeddedtrailer": true, 907 + "hoppercapacity": 0, 908 + "hopperdischargespeed": 0, 909 + "modelType": 0 910 +} 911 + 912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 913 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 914 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 915 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 916 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 917 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 918 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 919 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 920 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 921 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 922 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 923 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 924 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 925 + 926 +== (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 927 + 928 +(% class="box warningmessage" %) 929 +((( 930 +(% style="color:#000000" %)// //(% lang="en-US" %)**PUT /api/v3/models** 931 +))) 932 + 933 +(% style="color:#000000" %)Метод позволяет изменить статус модели, указанного в запросе. 934 + 935 +(% style="color:#000000" %)Метод запроса: **PUT** 936 + 937 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/(% lang="en-US" %)api/v3/models 938 + 939 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 940 + 941 +(% style="color:#000000" %)Параметры в теле запроса (JSON): 942 + 943 +{ 944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 945 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 946 + "deleted": true, 947 + "extId": "string", 948 + "name": "string", 949 + "picture": "string", 950 + "minspeed": 0, 951 + "maxspeed": 0, 952 + "width": 0, 953 + "imbeddedtrailer": true, 954 + "fueloutlay": 0, 955 + "hoppercapacity": 0, 956 + "hopperdischargespeed": 0, 957 + "modelType": 0 958 +} 959 + 960 +Ответ: 961 + 962 +{ 963 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 964 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 965 + "deleted": true, 966 + "extId": "string", 967 + "name": "string", 968 + "picture": "string", 969 + "minspeed": 0, 970 + "maxspeed": 0, 971 + "width": 0, 972 + "imbeddedtrailer": true, 973 + "fueloutlay": 0, 974 + "hoppercapacity": 0, 975 + "hopperdischargespeed": 0, 976 + "modelType": 0 977 +} 978 + 979 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 980 +|(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 981 +|(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта 982 +|(% style="width:215px" %)(% style="color:#000000" %)parentName|(% style="width:861px" %)Имя клиента, которому принадлежит модель объекта 983 +|(% style="width:215px" %)(% style="color:#000000" %)name|(% style="width:861px" %)Имя модели объекта 984 +|(% style="width:215px" %)(% style="color:#000000" %)picture|(% style="width:861px" %)Название иконки транспорта 985 +|(% style="width:215px" %)(% style="color:#000000" %)minspeed|(% style="width:861px" %)Минимальная технологическая скорость обработки поля, в км/ч 986 +|(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 987 +|(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 988 +|(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 989 +|(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 990 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 991 +|(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 992 + 993 +== (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 994 + 995 +(% class="box errormessage" %) 996 +((( 997 +(% lang="en-US" %)**DELETE /api/v3/models/{Id}** 998 +))) 999 + 1000 +(% style="color:#000000" %)Метод позволяет удалить модели. Метод позволяет удалить модель, указанного в строке запроса. 1001 + 1002 +(% style="color:#000000" %)Метод запроса: **DELETE** 1003 + 1004 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru(% lang="en-US" %)/api/v3/models/{Id} 1005 + 1006 +(% style="color:#000000" %)Параметр запроса: {**__id__**} - id модели 1007 + 1008 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1009 + 1010 +Ответ: В случае успеха **Success 200** 1011 + 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 1013 + 687 687 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 688 688 689 689 (% class="box infomessage" %) ... ... @@ -711,6 +711,17 @@ 711 711 712 712 ((( 713 713 { 1041 + 1042 +((( 1043 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1044 + "IsSackEnabled": true, ~/~/ Определяет, должен ли внутренний сервер отвечать устройству сообщением SACK при получении сообщения от устройства 1045 +))) 1046 + 1047 +((( 1048 + ~/~/Используется только на ТС с типом устройства quecklink gv56, quecklink gv58, quecklink 1049 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1050 +))) 1051 + 714 714 "vehicleId": "", ~/~/ ID объекта 715 715 "name": "", ~/~/ Имя объекта 716 716 "imei": "", ~/~/ IMEI объекта ... ... @@ -718,19 +718,15 @@ 718 718 "deviceTypeName": "", ~/~/ Название типа устройства 719 719 "sim1": "", ~/~/ Номер SIM1 720 720 "sim2": "", ~/~/ Номер SIM2 721 - 722 722 "parentId": "", ~/~/ ID клиента-родителя 723 723 "parentName": "", ~/~/ Наименование клиента-родителя 724 724 "modelId": "", ~/~/ ID модели объекта 725 725 "modelName": "", ~/~/ Имя модели объекта 726 - 727 727 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 728 728 "unitName": "string", ~/~/ Наименование подразделения 729 729 "status": 0, ~/~/ Статус объекта 730 - 731 731 "createdAt": "", ~/~/ Дата создания объекта 732 732 }, 733 - 734 734 "customFields": [ ~/~/ Произвольные поля 735 735 { 736 736 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -753,8 +753,7 @@ 753 753 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 754 754 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 755 755 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 756 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 757 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 758 758 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 759 759 "mileageCoeff": 0, ~/~/ коэффициент пробега 760 760 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -784,57 +784,68 @@ 784 784 "retries": 0 ~/~/ Количество попыток 785 785 } 786 786 ], 787 - 788 788 "sensors": [ ~/~/ Датчики 789 789 { 790 790 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 791 - "kind": 0, ~/~/ Тип, 0- простой,1- виртуальный1123 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 792 792 "type": 0, ~/~/ Тип датчика 793 793 "name": "string", ~/~/ Имя датчика 794 - "inputType": 0, ~/~/ Тип входа 1126 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 795 795 "inputNumber": 0, ~/~/ Номер входа 796 796 "pseudonym": "string", ~/~/ Псевдоним 797 797 "medianDegree": 0, ~/~/ Медианная фильтрация 798 798 "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 799 799 "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 800 - "gradeType": 0, ~/~/ Тип тарировки 801 - "gradesTables": [ ~/~/ ТиптарировкиТаблица1132 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1133 + "gradesTables": [ ~/~/ Массив таблиц тарировки 802 802 { 803 - "grades": [ ~/~/ Тарировк а1135 + "grades": [ ~/~/ Таблица тарировки 1 804 804 { 805 805 "input": 0, ~/~/ Входящее значение 806 806 "output": 0 ~/~/ Выходящее значение 807 807 } 808 808 ], 809 - "relevanceTime": "2023-05-22T09:57:39.562Z" 1141 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 810 810 } 811 811 ], 812 812 "showInTooltip": true, ~/~/ Отображать в подсказке 813 813 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 814 814 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 815 815 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 816 - "agrFunction": 0, 817 - "expr": "string", 818 - "children": [ 1149 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1150 + "expr": "string", ~/~/ Формула 1151 + "children": [ ~/~/ массив дочерних датчиков 819 819 "string" 820 820 ], 821 - "customParams": { 1154 + "customParams": { ~/~/ прочие произвольные параметры 822 822 "additionalProp1": "string", 823 823 "additionalProp2": "string", 824 824 "additionalProp3": "string" 825 825 }, 826 - "summaryMaxValue": 0 827 - } 828 828 1160 +~/~/ Характерные для произвольного: 1161 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1162 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1163 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1164 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1165 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1166 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1167 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1168 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1169 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1170 +~/~/ "ValueOn": "Вкл.", 1171 +~/~/ "ValueOff": "Выкл." 1172 + "summaryMaxValue": 0 ~/~/ Макс. значение 1173 + } 829 829 "drivers": [ ~/~/ Водители 830 830 { 831 831 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 832 - "name": "string", 1177 + "name": "string", ~/~/ Наименование 833 833 "description": "string", 834 - "isDefault": true 1179 + "isDefault": true ~/~/ По умолчанию 835 835 } 836 836 ], 837 - 838 838 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 839 839 { 840 840 "id": "", ~/~/ ID задания ... ... @@ -851,19 +851,27 @@ 851 851 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 852 852 } 853 853 ], 854 - 855 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 856 856 { 857 857 "status": 0, 858 858 "date": "2023-05-22T09:57:39.562Z", 859 859 "description": "string", 860 860 "additionalInfo": "string" 861 - } 862 - ] 863 863 1205 +((( 864 864 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 865 865 ))) 866 866 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 867 867 (% style="text-align:left" %) 868 868 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 869 869 ... ... @@ -870,6 +870,75 @@ 870 870 (% style="text-align:left" %) 871 871 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 872 872 1225 + 1226 +== **Отправить команду на терминал** == 1227 + 1228 +(% class="box successmessage" %) 1229 +((( 1230 +(% lang="en-US" %)**POST **(%%)**/api/v3/Vehicles/cmd/create** 1231 +))) 1232 + 1233 +Команда для отправки на тс. 1234 + 1235 +{ 1236 +"id": "", ~/~/идентификатор объекта (он же идентификатор ТС: vehicleId) 1237 +"command": "", ~/~/ Текст отправляемой команды 1238 +"retries": "", ~/~/ Количество попыток отправки на терминал 1239 +"idTemplate": "" ~/~/ ID шаблона команды (при использовании ранее созданных шаблонов). 1240 +} 1241 + 1242 +В ответ получаем cmdid 1243 + 1244 + 1245 +== **Получить ответ на отправленную на ТС команду** == 1246 + 1247 +(% class="box infomessage" %) 1248 +((( 1249 +(% lang="en-US" %)**GET **(%%)**/api/v3/Vehicles/cmd/{cmdId}/answer** 1250 +))) 1251 + 1252 +Идентификатор команды: cmdId 1253 + 1254 +Запрос от терминала на ответ команды 1255 + 1256 +Пример ответ от терминала: 1257 + 1258 +ID= "" ~/~/ идентификатор объекта 1259 +Soft="" ~/~/ версия софта 1260 +GPS=4 ~/~/ тип трекера 1261 +Time=11:05:43 28.06.24 ~/~/ время запроса 1262 +Lat=45.056221 ~/~/ широта 1263 +Lon=39.035938 ~/~/ долгота 1264 +Speed=0.0 ~/~/ скорость 1265 +Course=181.4 ~/~/направление 1266 + 1267 +((( 1268 +== **Список отправленных объекту команд с ответами** == 1269 + 1270 +(% class="box infomessage" %) 1271 +((( 1272 +(% lang="en-US" %)**GET**(%%)**/api/v3/Vehicles/cmd/{vehicleId}/history** 1273 +))) 1274 + 1275 +Идентификатор ТС: vehicleId 1276 + 1277 +В ответе приходит список команд с их ID, временем отправки, количестве попыток отправки и ответами терминала. 1278 + 1279 +Пример ответа терминала 1280 + 1281 +[ 1282 +{ 1283 +"id": "", ~/~/ идентификатор пользователя 1284 +"commandText": "", ~/~/Текст команды. 1285 +"templateId": "", ~/~/Идентификатор шаблона 1286 +"updated": "", ~/~/ Время отправки 1287 +"tryCount": 0, ~/~/ Количество попыток отправки команды 1288 +"answer": "", ~/~/ Ответ терминала. 1289 +"status": "" ~/~/ Статус отправки 1290 +} 1291 +] 1292 +))) 1293 + 873 873 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 874 874 875 875 (% class="box successmessage" %) ... ... @@ -889,6 +889,11 @@ 889 889 890 890 (% style="color:#000000" %){ 891 891 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 892 892 "parentId": "" , ~/~/ ID клиента 893 893 "name": "" , ~/~/ имя ТС 894 894 "imei": "" , ~/~/ IMEI ... ... @@ -909,7 +909,6 @@ 909 909 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 910 910 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 911 911 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 912 - 913 913 "mileageCalcMethod": 0, 914 914 "mileageCoeff": 0, 915 915 "locationByCellId": true, ... ... @@ -942,7 +942,6 @@ 942 942 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 943 943 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 944 944 } 945 - 946 946 "drivers": [ ~/~/ Водители 947 947 { 948 948 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -957,117 +957,261 @@ 957 957 "retries": 0 958 958 } 959 959 ], 960 - 1384 +"sensors": [ ~/~/ Датчики 961 961 { 962 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 963 - "kind": 0, 964 - "type": 0, 965 - "name": "string", 966 - "inputType": 0, 967 - "inputNumber": 0, 968 - "pseudonym": "string", 969 - "medianDegree": 0, 970 - "isInverted": true, 971 - "disabled": true, 972 - "gradeType": 0, 973 - "gradesTables": [ 1386 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1387 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1388 + "type": 0, ~/~/ Тип датчика 1389 + "name": "string", ~/~/ Имя датчика 1390 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1391 + "inputNumber": 0, ~/~/ Номер входа 1392 + "pseudonym": "string", ~/~/ Псевдоним 1393 + "medianDegree": 0, ~/~/ Медианная фильтрация 1394 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1395 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1396 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1397 + "gradesTables": [ ~/~/ Массив таблиц тарировки 974 974 { 975 - "grades": [ 1399 + "grades": [ ~/~/ Таблица тарировки 1 976 976 { 977 - "input": 0, 978 - "output": 0 1401 + "input": 0, ~/~/ Входящее значение 1402 + "output": 0 ~/~/ Выходящее значение 979 979 } 980 980 ], 981 - "relevanceTime": "2023-05-22T 12:19:59.728Z"1405 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 982 982 } 983 983 ], 984 - "showInTooltip": true, 985 - "showLastValid": true, 986 - "showAsDutOnGraph": true, 987 - "showWithoutIgn": true, 988 - "agrFunction": 0, 989 - "expr": "string", 990 - "children": [ 1408 + "showInTooltip": true, ~/~/ Отображать в подсказке 1409 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1411 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1412 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1413 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1414 + "expr": "string", ~/~/ Формула 1415 + "children": [ ~/~/ массив дочерних датчиков 991 991 "string" 992 992 ], 993 - "customParams": { 1418 + "customParams": { ~/~/ прочие произвольные параметры 994 994 "additionalProp1": "string", 995 995 "additionalProp2": "string", 996 996 "additionalProp3": "string" 997 997 }, 998 - "summaryMaxValue": 0 1423 +~/~/ Характерные для произвольного: 1424 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1425 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1426 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1427 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1428 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1429 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1430 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1431 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1432 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1433 +~/~/ "ValueOn": "Вкл.", 1434 +~/~/ "ValueOff": "Выкл." 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 999 999 } 1000 1000 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1001 1001 "customFields": [ ~/~/ Произвольные поля 1002 1002 { 1003 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1004 - "name": "string", 1005 - "value": "string", 1006 - "forClient": true, 1007 - "forTooltip": true, 1008 - "forReport": true 1009 - } 1010 - ] 1454 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1455 + "name": "string", ~/~/ Наименование произвольного поля 1456 + "value": "string", ~/~/ Значение произвольного поля 1457 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1458 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1459 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1460 + 1461 +((( 1462 + } 1463 + ], 1464 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1465 +))) 1466 + 1467 +((( 1468 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1011 1011 } 1470 +))) 1012 1012 1472 + 1013 1013 (% style="color:#000000" %)Ответ: 1014 1014 1015 -(% style="color:#000000" %){ 1016 1016 1017 - "vehicleId": "", ~/~/ID ТС 1018 - "parentId": "", ~/~/Guid владельца ТС 1019 - "name": "", ~/~/Имя объекта 1020 - "imei": "", ~/~/IMEI 1021 - "deviceTypeId": "", ~/~/ID типа устройства 1022 - "modelId": "", ~/~/ID модели 1023 - "unitId": "", ~/~/ID подразделения 1024 - "sim1": "", ~/~/SIM1 1025 - "sim2": "", ~/~/SIM2 1026 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1027 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1028 - "counters": { ~/~/Счётчики 1029 - "mileageEnabled": true, 1030 - "motohoursEnabled": true, 1031 - "mileage": "", 1032 - "motohours": 345.0 1033 - }, 1034 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1035 - "id": null, 1036 - "enabled": true, ~/~/флаг включения 1037 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1038 - "login": "", ~/~/ имя учетной записи 1039 - "password": "" ~/~/ пароль учетной записи 1040 - }, 1041 - "inspectionTasks": { ~/~/ задания на ТО 1042 - "id": "", ~/~/ ID задачи 1043 - "enabled": false, ~/~/ Признак включения 1044 - "name": "", ~/~/ Имя задания 1045 - "description": "", ~/~/ Описание задания 1046 - "mileageCondition": "", ~/~/ Условие по пробегу 1047 - "lastMileage": "", ~/~/ Пробег (в метрах) 1048 - "motohoursCondition": "", ~/~/ Условие по моточасам 1049 - "lastMotohours": "", ~/~/ Моточасы 1050 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1051 - "kind": "", ~/~/ Вид периодичности по времени 1052 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1476 +((( 1477 +((( 1478 +((( 1479 +{ 1480 + "vehicleId": 0, ~/~/ ID ТС 1481 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1482 + "name": "string", ~/~/ Имя объекта 1483 + "imei": "string", ~/~/ IMEI 1484 + "deviceTypeId": 0, ~/~/ ID типа устройства 1485 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1486 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1487 + "sim1": "string", ~/~/ SIM1 1488 + "sim2": "string", ~/~/ SIM2 1489 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1490 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1491 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1492 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1493 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1494 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1495 + "consumptionPer100KmSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1496 + "consumptionPer100KmSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1497 + "consumptionPerHourSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1498 + "consumptionPerHourSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1499 + "consumptionIdleSeasonalBegin": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1500 + "consumptionIdleSeasonalEnd": "2024-10-30T08:11:35.622Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1501 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега (0 - ByGps, 1 - ByMileageSensor) 1502 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1503 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1504 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1505 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1506 + "counters": { ~/~/ Dto для состояний счётчиков 1507 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1508 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1509 + "mileage": 0, ~/~/ Пробег 1510 + "motohours": 0 ~/~/ Моточасы 1511 + }, 1512 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1513 + "id": "string", ~/~/ CMSV6 Идентификатор 1514 + "enabled": true, ~/~/ Признак включения 1515 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 1516 + "login": "string", ~/~/ CMSV6 имя учетной записи 1517 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 1518 + }, 1519 + "inspectionTasks": [ ~/~/ Dto для описания задачи на ТО 1520 + { 1521 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 1522 + "enabled": true, ~/~/ Признак включения 1523 + "name": "string", ~/~/ Имя задания 1524 + "description": "string", ~/~/ Описание задания 1525 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 1526 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 1527 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 1528 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 1529 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 1530 + "kind": 0, ~/~/ Определяет вид периодичности ТО.( 0 - Дни, 1 - Месяцы , 2 - Годы) 1531 + "lastInspectionDate": "2024-10-30T08:11:35.622Z", ~/~/ Дата последнего ТО 1532 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 1053 1053 } 1534 + ], 1535 + "drivers": [ ~/~/ Список водителей. Определяет класс назначения водителя на объект. 1536 + { 1537 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1538 + "inputNumber": 0, ~/~/ № входа. 1539 + "createTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени создания назначения. 1540 + "comment": "string", ~/~/ Комментарий 1541 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1542 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1543 + "beginTime": "2024-10-30T08:11:35.622Z", ~/~/ Момент времени начала назначения. 1544 + "endTime": "2024-10-30T08:11:35.622Z" ~/~/ Момент времени окончания назначения. 1545 + } 1546 + ], 1547 + "commandTemplates": [ ~/~/ Список шаблонов команд 1548 + { 1549 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 1550 + "name": "string", ~/~/ Название шаблона команд 1551 + "command": "string", ~/~/ Команда на выполнение 1552 + "retries": 0 ~/~/ Лимит попыток отправки 1553 + } 1554 + ], 1555 + "sensors": [ ~/~/ Список датчиков 1556 + { 1557 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1558 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 1559 + "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 1560 + "name": "string", ~/~/ Имя датчика 1561 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 1562 + "inputNumber": 0, ~/~/ Номер входа 1563 + "pseudonym": "string", ~/~/ Псевдоним 1564 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 1565 + "isInverted": true, ~/~/ Признак инверсии 1566 + "disabled": true, ~/~/ Датчик не участвует в обработке 1567 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1568 + "gradesTables": [ ~/~/ Тарировка 1569 + { 1570 + "grades": [ ~/~/ Таблицы тарировки 1571 + { 1572 + "input": 0, ~/~/ Вход 1573 + "output": 0 ~/~/ Выход 1574 + } 1575 + ], 1576 + "relevanceTime": "2024-10-30T08:11:35.622Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1577 + } 1578 + ], 1579 + "showInTooltip": true, ~/~/ Отображение в подсказке 1580 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1581 + "color": "string", ~/~/ код цвета датчиков 1582 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1583 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 1584 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 1585 + "expr": "string", ~/~/ Выражение 1586 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 1587 + "string" 1588 + ], 1589 + "customParams": { 1590 + "additionalProp1": "string", 1591 + "additionalProp2": "string", 1592 + "additionalProp3": "string" 1593 + }, 1594 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 1595 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1596 + { 1597 + "from": 0, ~/~/ С какого значения 1598 + "color": "string", ~/~/ Каким цветом 1599 +))) 1054 1054 1055 -(% style="text-align:left" %) 1056 -(% style="color:#000000" %)} 1601 +((( 1602 + "text": "string" ~/~/ Текст подписи к этому интервалу 1603 + } 1604 + ] 1605 + } 1606 + ], 1607 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1608 + "customFields": [ ~/~/ Список произвольных полей 1609 + { 1610 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1611 + "name": "string", ~/~/ Наименование произвольного поля 1612 + "value": "string", ~/~/ Значение произвольного поля 1613 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1614 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1615 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1616 + } 1617 + ], 1618 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1619 +} 1620 +))) 1621 +))) 1622 +))) 1057 1057 1624 + 1058 1058 **Валидация:** 1059 1059 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1060 1060 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1061 1061 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1062 1062 1063 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1064 1064 1631 +== (% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами**(%%) == 1632 + 1065 1065 (% class="box infomessage" %) 1066 1066 ((( 1067 1067 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1068 1068 ))) 1069 1069 1070 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1638 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1071 1071 1072 1072 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1073 1073 ... ... @@ -1101,9 +1101,12 @@ 1101 1101 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1102 1102 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1103 1103 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1104 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1105 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1106 - "customFields": null ~/~/ значение любого из произвольных полей ТС 1672 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ ID подразделения (опционально) 1673 + "unitName": "string", ~/~/ Название подразделения (опционально) 1674 + "customFields": "string", ~/~/ Поиск по содержимому произвольных полей ТС (опционально) 1675 + "vehicleGroupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID группы ТС (опционально) 1676 + "vehicleGroupName": "string", ~/~/ Название группы ТС (опционально) 1677 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор агента, для которого надо получить данные 1107 1107 } 1108 1108 1109 1109 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1110,8 +1110,14 @@ 1110 1110 1111 1111 (% style="color:#000000" %)Ответ: 1112 1112 1113 -(% style="color:#000000" %){ 1684 +(% style="color:#000000" %)[ 1685 +{ 1114 1114 1687 +((( 1688 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1689 +))) 1690 + 1691 +((( 1115 1115 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1116 1116 "name": "" ~/~/ наименование объекта 1117 1117 "imei": "" ~/~/ IMEI объекта ... ... @@ -1137,9 +1137,21 @@ 1137 1137 "forClient": true, ~/~/ право на отображение у клиента 1138 1138 "forTooltip": false, ~/~/ право на отображение в подсказке 1139 1139 "forReport": false ~/~/ право на отображение в отчетах 1140 - }(%%) 1141 -(% style="color:#000000" %)} 1717 +))) 1142 1142 1719 +((( 1720 + } 1721 + ], 1722 + "vehicleGroups": [ ~/~/ Группы ТС 1723 + { 1724 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1725 + "name": "string" ~/~/ Наименование группы ТС 1726 + } 1727 + ] 1728 + } 1729 +] 1730 +))) 1731 + 1143 1143 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1144 1144 1145 1145 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1171,13 +1171,11 @@ 1171 1171 "data": "", ~/~/ Данные 1172 1172 "overwrite": false, ~/~/ Флаг перезаписи 1173 1173 "stage": "", ~/~/ Состояние, может быть null 1174 - 1175 1175 (% style="color:#000000" %)} 1176 1176 1177 1177 (% style="color:#000000" %)Ответ: 1178 1178 1179 -(% style="color:#000000" %){ 1180 - 1767 +(% style="color:#000000" %){(%%) 1181 1181 "status": "", ~/~/ значение статуса 1182 1182 "date": "", ~/~/ Дата смены статуса 1183 1183 "description": "", ~/~/ Описание ... ... @@ -1184,10 +1184,9 @@ 1184 1184 "data": "", ~/~/ Данные 1185 1185 "overwrite": false, ~/~/ Флаг перезаписи 1186 1186 "stage": "", ~/~/ Состояние 1187 - 1188 -(% style="text-align:left" %) 1189 1189 (% style="color:#000000" %) } 1190 1190 1776 + 1191 1191 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1192 1192 1193 1193 (% class="box warningmessage" %) ... ... @@ -1205,18 +1205,16 @@ 1205 1205 1206 1206 (% style="color:#000000" %)Параметры в теле запроса (JSON): 1207 1207 1208 -(% style="color:#000000" %){ 1209 - 1210 -((( 1211 -(% style="color:#000000" %) "vehicleId": "", ~/~/ ID ТС 1212 - "parentId": "", ~/~/ ID клиента 1213 - "name": "", ~/~/ имя ТС 1214 - "imei": "", ~/~/ IMEI 1215 - "deviceTypeId": "", ~/~/ ID типа устройства 1216 - "modelId": "", ~/~/ , ID модели 1217 - "unitId": "", ~/~/ подразделения 1218 - "sim1": "", ~/~/ SIM 1 1219 - "sim2": "", ~/~/ SIM2 (%%) 1794 +(% style="color:#000000" %){ 1795 + "vehicleId": , ~/~/ ID объекта 1796 + "parentId": "" , ~/~/ ID клиента 1797 + "name": "" , ~/~/ имя ТС 1798 + "imei": "" , ~/~/ IMEI 1799 + "deviceTypeId": "" , ~/~/ ID типа устройства 1800 + "modelId": "" , ~/~/ ID модели 1801 + "unitId": "" , ~/~/ ID подразделения 1802 + "sim1": "" , ~/~/ Номер SIM 1 1803 + "sim2": "" , ~/~/ Номер SIM2 1220 1220 "consumptionPer100Km": "" , ~/~/ Расход топлива на 100 км (если заполнено, то consumptionPerHour не может быть заполнено) 1221 1221 "consumptionPerHour": "" , ~/~/ Расход топлива за моточас (если заполнено, то consumptionPer100Km не может быть заполнено) 1222 1222 "consumptionIdle": "" , ~/~/ Расход топлива на холостом ходу ... ... @@ -1229,89 +1229,326 @@ 1229 1229 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1230 1230 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1231 1231 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1232 -(% style="color:#000000" %) "counters": 1233 - { 1234 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1235 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1236 - "mileage": "", ~/~/ пробег, в метрах 1237 - "motohours": "" ~/~/ моточасы, в секундах 1238 - } 1239 - "cmsv6Parameters": ~/~/ параметры CMSv6 1240 - { 1241 - "id": "", ~/~/ идентификатор 1242 - "enabled": true, ~/~/ флаг включения 1243 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1244 - "login": "", ~/~/ имя учетной записи 1245 - "password": "", ~/~/ пароль учетной записи 1246 - } 1247 - "inspectionTasks": ~/~/ задания на ТО 1248 - { 1249 - "id": "", ~/~/ ID задания 1250 - "enabled": false, ~/~/ Признак включения 1251 - "name": "", ~/~/ Имя задания 1252 - "description": "", ~/~/ Описание задания 1253 - "mileageCondition": "", ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1254 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1255 - "motohoursCondition": "", ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1256 - "lastMotohours": "", ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1257 - "periodicCondition": "", ~/~/ Условие периодичности по времени (null - условие не работает) 1258 - "kind": "", ~/~/ Вид периодичности по времени 1259 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 1260 - } 1816 + 1817 + "mileageCalcMethod": 0, 1818 + "mileageCoeff": 0, 1819 + "locationByCellId": true, 1820 + "dottedLineTrackWhenNoCoords": true, 1821 + "counters": ~/~/ счетчики 1822 + { 1823 + "mileage": "" , ~/~/ пробег 1824 + "mileageEnabled": true, ~/~/ флаг активности счётчика "пробег" 1825 + "motohours": "" , ~/~/ моточасы 1826 + "motohoursEnabled": true ~/~/ флаг активности счётчика "моточасы" 1827 + }, 1828 + "cmsv6Parameters": { ~/~/ параметры CMSv6 1829 + "enabled": true, ~/~/ флаг включения 1830 + "id": "" , ~/~/ идентификатор 1831 + "host": "" , ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1832 + "login": "" , ~/~/ имя учетной записи 1833 + "password": "" ~/~/ пароль учетной записи 1834 + }, 1835 + "inspectionTasks": ~/~/ задания на ТО 1836 + { 1837 + "enabled": "" , ~/~/ Признак включения 1838 + "name": "" , ~/~/ Имя задания 1839 + "description": "" , ~/~/ Описание задания 1840 + "mileageCondition": "" , ~/~/ Условие по пробегу (в метрах, null - условие не работает) 1841 + "lastMileage": "" , ~/~/ Пробег (в метрах) на момент последнего ТО (null - неважно) 1842 + "motohoursCondition": "" , ~/~/ Условие по моточасам (в секундах, null - условие не работает) 1843 + "lastMotohours": "" , ~/~/ Моточасы (в секундах) на момент последнего ТО (null - неважно) 1844 + "periodicCondition": "" , ~/~/ Условие периодичности по времени (null - условие не работает) 1845 + "kind": "" , ~/~/ Вид периодичности по времени (дни - Days, месяцы - Months, года - Years, null - условие не работает) 1846 + "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1847 + "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1848 + } 1849 + 1850 +"drivers": [ ~/~/ Водители 1851 + { 1852 + 1853 +((( 1854 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1855 + "inputNumber": 0, ~/~/ № входа. 1856 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1857 + "comment": "string", ~/~/ Комментарий. 1858 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1859 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1860 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1861 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1261 1261 ))) 1262 1262 1263 -(% style="color:#000000" %)} 1864 + } 1865 + ], 1866 + "commandTemplates": [ ~/~/ Шаблон команды 1867 + { 1868 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1869 + "name": "string", 1870 + "command": "string", 1871 + "retries": 0 1872 + } 1873 + ], 1874 +"sensors": [ ~/~/ Датчики 1875 + { 1876 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1877 + "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный 1878 + "type": 0, ~/~/ Тип датчика 1879 + "name": "string", ~/~/ Имя датчика 1880 + "inputType": 0, ~/~/ Тип входа, Analog, Digital, Impulse, ImpulseFrequency, Diagnosis, Rs485, Rs232, Wire, FMS, BLE 1881 + "inputNumber": 0, ~/~/ Номер входа 1882 + "pseudonym": "string", ~/~/ Псевдоним 1883 + "medianDegree": 0, ~/~/ Медианная фильтрация 1884 + "isInverted": true, ~/~/ Инвертировать, true - Вкл., false - Выкл. 1885 + "disabled": true, ~/~/ Состояние: Отключен, true - Вкл., false - Выкл. 1886 + "gradeType": 0, ~/~/ Тип тарировки, 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 1887 + "gradesTables": [ ~/~/ Массив таблиц тарировки 1888 + { 1889 + "grades": [ ~/~/ Таблица тарировки 1 1890 + { 1891 + "input": 0, ~/~/ Входящее значение 1892 + "output": 0 ~/~/ Выходящее значение 1893 + } 1894 + ], 1895 + "relevanceTime": "2023-05-22T09:57:39.562Z" ~/~/ Дата/время начала применения тарировочной таблицы 1896 + } 1897 + ], 1898 + "showInTooltip": true, ~/~/ Отображать в подсказке 1899 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1264 1264 1901 +((( 1902 + "color": "string",** ~/~/ **Цвет датчика 1903 +))) 1904 + 1905 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1906 + "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1907 + "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION 1908 + "expr": "string", ~/~/ Формула 1909 + "children": [ ~/~/ массив дочерних датчиков 1910 + "string" 1911 + ], 1912 + "customParams": { ~/~/ прочие произвольные параметры 1913 + "additionalProp1": "string", 1914 + "additionalProp2": "string", 1915 + "additionalProp3": "string" 1916 + }, 1917 +~/~/ Характерные для произвольного: 1918 +~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1919 +~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1920 +~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1921 +~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1922 +~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1923 +~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1924 +~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1925 +~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1926 +~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1927 +~/~/ "ValueOn": "Вкл.", 1928 +~/~/ "ValueOff": "Выкл." 1929 + "summaryMaxValue": 0 ~/~/ Макс. значение 1930 + 1931 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1932 + { 1933 + "from": 0, ~/~/ С какого значения 1934 + "color": "string", ~/~/ Каким цветом 1935 + "text": "string" ~/~/ Текст подписи к этому интервалу 1936 + } 1937 + ] 1938 + } 1939 + ], 1940 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1941 + 1942 + "customFields": [ ~/~/ Произвольные поля 1943 + { 1944 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1945 + "name": "string", ~/~/ Наименование произвольного поля 1946 + "value": "string", ~/~/ Значение произвольного поля 1947 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1948 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1949 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1950 + } 1951 + 1952 +((( 1953 + ], 1954 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1955 +))) 1956 + 1957 +} 1958 + 1959 + 1265 1265 (% style="color:#000000" %)Ответ: 1266 1266 1267 -(% lang="en-US" style="text-align:left" %) 1268 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1962 +((( 1963 +{ 1964 + "vehicleId": 0, ~/~/ ID ТС 1965 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1966 + "name": "string", ~/~/ Имя объекта 1967 + "imei": "string", ~/~/ IMEI 1968 + "deviceTypeId": 0, ~/~/ ID типа устройства 1969 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1970 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1971 + "sim1": "string", ~/~/ SIM1 1972 + "sim2": "string", ~/~/ SIM2 1973 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1974 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1975 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1976 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1977 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1978 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1979 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1980 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1981 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1982 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1983 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1984 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1985 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1986 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1987 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1988 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1989 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1990 + "counters": { ~/~/ состояний счётчиков 1991 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1992 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1993 + "mileage": 0, ~/~/ Пробег 1994 + "motohours": 0 ~/~/ Моточасы 1995 + }, 1996 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1997 + "id": "string", ~/~/ CMSV6 Идентификатор 1998 + "enabled": true, ~/~/ Признак включения 1999 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2000 +))) 1269 1269 1270 -(% lang="en-US" style="text-align:left" %) 1271 - "vehicleId": "", ~/~/ ID ТС 1272 - "parentId": "", ~/~/ ID клиента 1273 - "name": "", ~/~/ имя ТС 1274 - "imei": "", ~/~/ IMEI 1275 - "deviceTypeId": "", ~/~/ типа устройства 1276 - "modelId": "", ~/~/ ID модели 1277 - "unitId": "", ~/~/ ID подразделения 1278 - "sim1": "", ~/~/ SIM 1 1279 - "sim2": "", ~/~/ SIM2 1280 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1281 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1282 - "counters": 1283 - { 1284 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1285 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1286 - "mileage": "", ~/~/ пробег 1287 - "motohours": "", ~/~/ моточасы 1288 - } 1289 - "cmsv6Parameters": ~/~/ параметры CMSv6 2002 + 2003 +((( 2004 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2005 + "login": "string", ~/~/ CMSV6 имя учетной записи 2006 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2007 + }, 2008 + "inspectionTasks": [ ~/~/ Задания на ТО 2009 + { 2010 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2011 + "enabled": true, ~/~/ Признак включения 2012 + "name": "string", ~/~/ Имя задания 2013 + "description": "string", ~/~/ Описание задания 2014 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2015 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2016 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2017 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2018 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2019 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2020 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2021 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2022 + } 2023 + ], 2024 + "drivers": [ ~/~/ Список водителей 2025 + { 2026 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2027 + "inputNumber": 0, ~/~/ № входа. 2028 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2029 + "comment": "string", ~/~/ Комментарий. 2030 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2032 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2033 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2034 + } 2035 + ], 2036 + "commandTemplates": [ ~/~/ Список шаблонов команд 2037 + { 2038 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2039 + "name": "string", ~/~/ Название шаблона команд 2040 + "command": "string", ~/~/ Команда на выполнение 2041 + "retries": 0 ~/~/ Лимит попыток отправки 2042 + } 2043 + ], 2044 + "sensors": [ ~/~/ Список датчиков 2045 + { 2046 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2047 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2048 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2049 +))) 2050 + 2051 +((( 2052 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2053 +))) 2054 + 2055 +((( 2056 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2057 +))) 2058 + 2059 +((( 2060 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2061 +))) 2062 + 2063 +((( 2064 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2065 +))) 2066 + 2067 +((( 2068 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2069 + "name": "string", ~/~/ Имя датчика 2070 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2071 +))) 2072 + 2073 +((( 2074 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2075 + "inputNumber": 0, ~/~/ Номер входа 2076 + "pseudonym": "string", ~/~/ Псевдоним 2077 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2078 + "isInverted": true, ~/~/ Признак инверсии 2079 + "disabled": true, ~/~/ Датчик не участвует в обработке 2080 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2081 + "gradesTables": [ ~/~/ Тарировка 1290 1290 { 1291 - "id": ~/~/ идентификатор 1292 - "enabled": true, ~/~/ флаг включения 1293 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1294 - "login": "", ~/~/ имя учетной записи 1295 - "password": "", ~/~/ пароль учетной записи 1296 - } 1297 - "inspectionTasks": ~/~/ задания на ТО 1298 - { 1299 - "id": "", ~/~/ ID задания 1300 - "enabled": false, ~/~/ Признак включения 1301 - "name": "", ~/~/ Имя задания 1302 - "description": "", ~/~/ Описание задания 1303 - "mileageCondition": "", ~/~/ Условие по пробегу 1304 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1305 - "motohoursCondition": "", ~/~/ Условие по моточасам 1306 - "lastMotohours": "", ~/~/ Моточасы 1307 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1308 - "kind": "", ~/~/ Вид периодичности по времени 1309 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2083 + "grades": [ ~/~/ Таблицы тарировки 2084 + { 2085 + "input": 0, ~/~/ Вход 2086 + "output": 0 ~/~/ Выход 2087 + } 2088 + ], 2089 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1310 1310 } 2091 + ], 2092 + "showInTooltip": true, ~/~/ Отображение в подсказке 2093 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1311 1311 1312 -(% lang="en-US" style="text-align:left" %) 1313 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2095 +((( 2096 + "color": "string", ~/~/ цвет уведомлений 2097 +))) 1314 1314 2099 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2100 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2101 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2102 + "expr": "string", ~/~/ Выражение 2103 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2104 + "string" 2105 + ], 2106 + "customParams": { ~/~/ Дополнительные настройки 2107 + "additionalProp1": "string", 2108 + "additionalProp2": "string", 2109 + "additionalProp3": "string" 2110 + }, 2111 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2112 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2113 + { 2114 + "from": 0, ~/~/ С какого значения 2115 + "color": "string", ~/~/ Каким цветом 2116 + "text": "string" ~/~/ Текст подписи к этому интервалу 2117 + } 2118 + ] 2119 + } 2120 + ], 2121 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2122 + "customFields": [ ~/~/ Список произвольных полей 2123 + { 2124 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2125 + "name": "string", ~/~/ Наименование произвольного поля 2126 + "value": "string", ~/~/ Значение произвольного поля 2127 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2128 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2129 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2130 + } 2131 + ], 2132 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2133 +} 2134 +))) 2135 + 1315 1315 **Валидация:** 1316 1316 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1317 1317 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1350,18 +1350,15 @@ 1350 1350 1351 1351 (% style="color:#000000" %)Метод запроса: **GET** 1352 1352 1353 -(% 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]]2174 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1354 1354 1355 1355 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1356 1356 1357 1357 (% style="color:#000000" %)Ответ: 1358 1358 1359 -(% style="color:#000000" %){ 1360 - 2180 +(% style="color:#000000" %){(%%) 1361 1361 "deviceTypeId" : "", ~/~/ ID типа устройства 1362 1362 "deviceTypeName" : "" ~/~/ Название типа устройства 1363 - 1364 -(% style="text-align:left" %) 1365 1365 (% style="color:#000000" %)} 1366 1366 1367 1367 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1383,13 +1383,10 @@ 1383 1383 1384 1384 (% style="color:#000000" %)Ответ: 1385 1385 1386 -(% style="color:#000000" %){ 1387 - 2204 +(% style="color:#000000" %){(%%) 1388 1388 "id": "", ~/~/ ID типа датчика 1389 1389 "name": "", ~/~/ Название 1390 1390 "description": "", ~/~/ Описание 1391 - 1392 -(% style="text-align:left" %) 1393 1393 (% style="color:#000000" %)} 1394 1394 1395 1395 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1433,6 +1433,56 @@ 1433 1433 } 1434 1434 ] 1435 1435 2251 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2252 + 2253 +(% class="box infomessage" style="text-align: left;" %) 2254 +((( 2255 +**POST /api/v3/terminalMessages/mapping** 2256 +))) 2257 + 2258 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2259 + 2260 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2261 + 2262 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2263 + 2264 +{ 2265 + "protocolType": 0, 2266 + "params": ["string"] 2267 +} 2268 + 2269 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2270 +|protocolType|ID типа протокола 2271 +|params|((( 2272 +Массив наименований параметров в сообщении 2273 +))) 2274 + 2275 +Ответ: 2276 + 2277 +{ 2278 + "protocolType": 0, 2279 + "mapping": { 2280 + "additionalProp1": { 2281 + "inputType": 0, 2282 + "inputNumber": 0 2283 + }, 2284 + "additionalProp2": { 2285 + "inputType": 0, 2286 + "inputNumber": 0 2287 + } 2288 + } 2289 +} 2290 + 2291 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2292 +|protocolType|Тип протокола 2293 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2294 +|inputNumber|((( 2295 +Номер входа 2296 +))) 2297 + 2298 +(% class="wikigeneratedid" %) 2299 +Перечень 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/]] 2300 + 1436 1436 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1437 1437 1438 1438 (% class="box infomessage" %) ... ... @@ -1457,6 +1457,11 @@ 1457 1457 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1458 1458 } 1459 1459 2325 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2326 +|vehicleId|ID объекта 2327 +|from|Дата и время начала периода запроса 2328 +|to|Дата и время окончания периода запроса 2329 + 1460 1460 Ответ: 1461 1461 1462 1462 [ ... ... @@ -1463,25 +1463,438 @@ 1463 1463 { 1464 1464 "messages": [ 1465 1465 { 1466 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1467 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1468 - "speed": 0, ~/~/ Скорость, км/ч 1469 - "altitude": 0, ~/~/ Высота, м 1470 - "latitude": 0, ~/~/ Широта [-90°;90°] 1471 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1472 - "satellites": 0, ~/~/ Кол-во спутников 1473 - "voltage": 0, ~/~/ Напряжение 1474 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2336 + "deviceTime": "2023-11-29T07:40:44.052Z", 2337 + "serverTime": "2023-11-29T07:40:44.052Z", 2338 + "speed": 0, 2339 + "altitude": 0, 2340 + "latitude": 0, 2341 + "longitude": 0, 2342 + "satellites": 0, 2343 + "course": 0, 2344 + "voltage": 0, 2345 + "parameters": { 1475 1475 "additionalProp1": "string", 1476 1476 "additionalProp2": "string", 1477 1477 "additionalProp3": "string" 1478 1478 }, 1479 - "photoCount": 0 ~/~/ Кол-во фото 2350 + "photoCount": 0, 2351 + "lbsCorrectedCoords": true, 2352 + "protocolType": 0 1480 1480 } 1481 1481 ] 1482 1482 } 1483 1483 ] 1484 1484 2358 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2359 +|deviceTime|Время сообщения терминала 2360 +|serverTime|Время когда сообщение поступило на сервер 2361 +|speed|Скорость 2362 +|altitude|Высота над уровнем моря 2363 +|latitude|Широта 2364 +|longitude|Долгота 2365 +|satellites|Кол-во спутников 2366 +|course|Курс 2367 +|voltage|Бортовое напряжение 2368 +|parameters|Список параметров и их значений 2369 +|photoCount|Количество фото 2370 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2371 +|protocolType|ID типа протокола 2372 + 2373 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 2374 + 2375 +== (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == 2376 + 2377 +(% class="box infomessage" %) 2378 +((( 2379 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/mileageAndMotohours** 2380 +))) 2381 + 2382 +(% style="color:#000000" %)Метод запроса: **POST** 2383 + 2384 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/mileageAndMotohours 2385 + 2386 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2387 + 2388 +(% style="text-align:left" %) 2389 +Тело запроса: 2390 + 2391 +{ 2392 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2393 + "vehicleIds": [0], ~/~/ Список ID объектов 2394 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2395 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2396 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2397 +} 2398 + 2399 +Ответ: 2400 + 2401 +[ 2402 + { 2403 + "vehicleId": 0, ~/~/ ID объекта 2404 + "name": "string", ~/~/ Имя ТС 2405 + "periods": [ ~/~/ Периоды 2406 + { 2407 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2408 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2409 + "mileage": 0, ~/~/ Пробег за период, километры 2410 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2411 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2412 + "motohours": 0, ~/~/ Моточасы за период, секунды 2413 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2414 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2415 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2416 + 2417 + } 2418 + ] 2419 + } 2420 +] 2421 + 2422 +== (% style="color:#000000; font-size:16px" %)**Получение данных о расходе транспортного средства**(%%) == 2423 + 2424 +(% class="box infomessage" %) 2425 +((( 2426 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelConsumption** 2427 +))) 2428 + 2429 +(% style="color:#000000" %)Метод запроса: **POST** 2430 + 2431 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelConsumption 2432 + 2433 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2434 + 2435 +(% style="text-align:left" %) 2436 +Тело запроса: 2437 + 2438 +{ 2439 + "sampling": 0, ~/~/ Частота дискретизации в секундах, минимум 60 секунд. Весь период разбивает на подпериоды с указанной частотой. 2440 + "vehicleIds": [0], ~/~/ Список ID объектов 2441 + "from": "2023-08-09T14:23:14.572Z", ~/~/ Начало периода 2442 + "to": "2023-08-09T14:23:14.572Z", ~/~/ Окончание периода 2443 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2444 +} 2445 + 2446 +Ответ: 2447 + 2448 +[ 2449 + { 2450 + "vehicleId": 0, ~/~/ ID объекта 2451 + "name": "string", ~/~/ Имя ТС 2452 + "periods": [ ~/~/ Периоды 2453 + { 2454 + "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 2455 + "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 2456 + "fuelLevelStart": 0, ~/~/ Уровень топлива на начало периода 2457 + "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 2458 + "fuelTankLevelStart": 0, ~/~/ Уровень топлива в цистерне на начало периода 2459 + "fuelTankLevelEnd": 0, ~/~/ Уровень топлива в цистерне на конец периода 2460 + "fuelConsumption": 0, ~/~/ Расход топлива 2461 + "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2462 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2463 + 2464 + } 2465 + ] 2466 + } 2467 +] 2468 + 2469 +(% class="box warningmessage" %) 2470 +((( 2471 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2472 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2473 +))) 2474 + 2475 +== (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 2476 + 2477 +(% class="box infomessage" %) 2478 +((( 2479 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/vehicles/fuelInOut** 2480 +))) 2481 + 2482 +(% style="color:#000000" %)Метод запроса: **POST** 2483 + 2484 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/fuelInOut 2485 + 2486 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2487 + 2488 +(% style="text-align:left" %) 2489 +Тело запроса: 2490 + 2491 +{ 2492 + "vehicleIds": [0], ~/~/ Список ID объектов 2493 + "from": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время начало запроса 2494 + "to": "2023-08-09T14:27:44.772Z", ~/~/ Дата и время окончания запроса 2495 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2496 +} 2497 + 2498 +Ответ: 2499 + 2500 +[ 2501 + { 2502 + "start": "2023-08-09T14:27:44.773Z", ~/~/ Начало периода 2503 + "end": "2023-08-09T14:27:44.773Z", ~/~/ Окончание периода 2504 + "vehicleId": 0, ~/~/ ID объекта 2505 + "name": "string", ~/~/ Имя объекта 2506 + "model": "string", ~/~/ Модель объекта 2507 + "fuels": [ ~/~/ Массив данным по заправкам и сливам 2508 + { 2509 + "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 2510 + 2511 + "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2512 + "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2513 + "valueFuel": 0, ~/~/ Количество 2514 + "fuelStart": 0, ~/~/ Уровень топлива на начало события 2515 + "fuelEnd": 0 ~/~/ Уровень топливо на конец события 2516 + } 2517 + ] 2518 + } 2519 +] 2520 + 2521 + 2522 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2523 + 2524 +(% class="box infomessage" %) 2525 +((( 2526 +**POST /api/v3/vehicles/moveStop** 2527 +))) 2528 + 2529 +Метод запроса: **POST** 2530 + 2531 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2532 + 2533 +В заголовках запроса: X-Auth: Токен авторизации 2534 + 2535 + 2536 +Тело запроса: 2537 + 2538 +{ 2539 + "vehicleIds": [ ], ~/~/ Список ID объектов 2540 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2541 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2542 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2543 +} 2544 + 2545 +Ответ: 2546 + 2547 +[ 2548 + { 2549 + "vehicleId": 0, ~/~/ ID объекта 2550 + "vehicleName": "string", ~/~/ Имя объекта 2551 + "moves": [ ~/~/ Событие движения 2552 + { 2553 + "mileage": 0, ~/~/ Пробег, км 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 + "stops": [ ~/~/ События стоянок 2562 + { 2563 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2564 + "eventId": 0, ~/~/ Идентификатор события 2565 + "eventName": "string", ~/~/ Название события 2566 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2567 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2568 + "duration": 0 ~/~/ Продолжительность события, секунд 2569 + } 2570 + ] 2571 + } 2572 +] 2573 + 2574 + 2575 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2576 + 2577 +(% class="box infomessage" %) 2578 +((( 2579 +**POST /api/v3/vehicles/getlastdata** 2580 +))) 2581 + 2582 +Метод запроса: **POST** 2583 + 2584 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2585 + 2586 +В заголовках запроса: X-Auth: Токен авторизации 2587 + 2588 + 2589 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2590 + 2591 +Ответ: 2592 + { 2593 + "vehicleId": 0, ~/~/Идентификатор объекта. 2594 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2595 + "vehicleNumber": "string",~/~/Номер объекта. 2596 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2597 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2598 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2599 + "speed": 0,~/~/Скорость объекта. 2600 + "course": 0,~/~/Курс движения [0;360] 2601 + "latitude": 0,~/~/Широта [-90°;90°]. 2602 + "longitude": 0,~/~/Долгота [-180°;180°]. 2603 + "address": "string",~/~/Адрес. 2604 + "geozones": [ ~/~/Сведения по геозонам. 2605 + { 2606 + "id": 0, 2607 + "name": "string" 2608 + } 2609 + 2610 + 2611 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2612 + 2613 +== (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == 2614 + 2615 +(% class="box infomessage" %) 2616 +((( 2617 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/find** 2618 +))) 2619 + 2620 +(% style="color:#000000" %)Метод позволяет получить список геообъектов клиента. Возвращает массив геообъектов со всей информацией о них. 2621 + 2622 +(% style="color:#000000" %)Метод запроса: **POST** 2623 + 2624 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/find 2625 + 2626 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2627 + 2628 +(% style="text-align:left" %) 2629 +Тело запроса: 2630 + 2631 +(% style="text-align:left" %) 2632 +{ 2633 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2634 +} 2635 + 2636 +(% style="text-align:left" %) 2637 +Ответ: 2638 + 2639 +[ 2640 + { 2641 + "id": 0, ~/~/ Идентификатор объекта геозоны 2642 + "name": "string", ~/~/ Название объекта геозоны 2643 + "type": 0, ~/~/ Тип объекта геозоны 2644 + "fname": "string", ~/~/ Имя файла 2645 + "parentId": "string", ~/~/ Идентификатор клиента 2646 + "radius": 0, ~/~/ Радиус геообъекта 2647 + "beginCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата начала расчета 2648 + "endCalc": "2023-08-01T07:54:54.893Z", ~/~/ Дата окончания расчета 2649 + "description": "string", ~/~/ Описание 2650 + "area": 0, ~/~/ Площадь, м^^2^^ 2651 + "perimetr": 0, ~/~/ Периметр, м 2652 + "createDate": "2023-08-01T07:54:54.893Z", ~/~/ Дата создания 2653 + } 2654 +] 2655 + 2656 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по объектам**(%%) == 2657 + 2658 +(% class="box infomessage" %) 2659 +((( 2660 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/vehicles** 2661 +))) 2662 + 2663 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных объектов со всеми геообъектами за выбранный период. 2664 + 2665 +(% style="color:#000000" %)Метод запроса: **POST** 2666 + 2667 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/vehicles 2668 + 2669 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2670 + 2671 +(% style="text-align:left" %) 2672 +Тело запроса: 2673 + 2674 +{ 2675 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2676 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2677 + "ids": [ ], ~/~/ Массив id объектов 2678 + "byTime": 0, ~/~/ Объединение событий по времени 2679 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2680 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2681 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2682 +} 2683 + 2684 +Ответ: 2685 +[ 2686 + { 2687 + "geozoneId": 0, ~/~/ ID геообъекта 2688 + "geozoneName": "string", ~/~/ Название геообъекта 2689 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2690 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2691 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2692 + "vehicleId": 0, ~/~/ ID объекта 2693 + "vehicleName": "string" ~/~/ Имя объекта 2694 + } 2695 +] 2696 + 2697 +== (% style="color:#000000; font-size:16px" %)**Запрос пересечений по геообъектам**(%%) == 2698 + 2699 +(% class="box infomessage" %) 2700 +((( 2701 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**POST **(%%)**/api/v3/gis/intersections/geozones** 2702 +))) 2703 + 2704 +(% style="color:#000000" %)Метод позволяет получить список пересечений выбранных геообъектов со всеми объектами за выбранный период. 2705 + 2706 +(% style="color:#000000" %)Метод запроса: **POST** 2707 + 2708 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/gis/intersections/geozones 2709 + 2710 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2711 + 2712 +(% style="text-align:left" %) 2713 +Тело запроса: 2714 + 2715 +{ 2716 + "startDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата начала запроса 2717 + "endDate": "2023-08-02T06:13:18.551Z", ~/~/ Дата окончания 2718 + "ids": [ ], ~/~/ Массив id геообъектов 2719 + "byTime": 0, ~/~/ Объединение событий по времени 2720 + "byDist": 0, ~/~/ Объединение событий по расстоянию 2721 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 2722 + "filterByHalfPerimeter": true ~/~/ Фильтрация событий по пробегу половины периметра 2723 +} 2724 + 2725 +Ответ: 2726 + 2727 +[ 2728 + { 2729 + "geozoneId": 0, ~/~/ ID геообъекта 2730 + "geozoneName": "string", ~/~/ Название геообъекта 2731 + "startDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата въезда 2732 + "endDate": "2023-08-02T06:13:18.554Z", ~/~/ Дата выезда 2733 + "duration": 0, ~/~/ Продолжительность нахождения в геообъекте 2734 + "vehicleId": 0, ~/~/ ID объекта 2735 + "vehicleName": "string" ~/~/ Имя объекта 2736 + } 2737 +] 2738 + 2739 + 2740 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2741 + 2742 +(% class="box successmessage" %) 2743 +((( 2744 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2745 +))) 2746 + 2747 +(% style="color:#000000" %)Метод запроса: **PUT** 2748 + 2749 +Пример запроса: 2750 + 2751 +((( 2752 +{ 2753 + "id": 0, ~/~/ Идентификатор объекта геозоны 2754 + "name": "string", ~/~/ Наименование объекта геозоны 2755 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2756 + "description": "string", ~/~/ Описание объекта геозоны 2757 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2758 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2759 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2760 +} 2761 +))) 2762 + 2763 + 2764 +Пример ответа: 2765 + 2766 +200 ~/~/ Success 2767 + 1485 1485 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 1486 1486 1487 1487 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -1513,7 +1513,7 @@ 1513 1513 "id": 0, ~/~/ ID уведомления 1514 1514 "name": "string", ~/~/ Название уведомления 1515 1515 "active": true, ~/~/ Состояние true - активен, false - деактивирован 1516 - "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО 2799 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя) 1517 1517 "userId": "", ~/~/ Пользователь, создавший уведомление 1518 1518 "parentId": "", ~/~/ Идентификатор клиента 1519 1519 "parentName": "string" ~/~/ Имя клиента ... ... @@ -1520,6 +1520,155 @@ 1520 1520 } 1521 1521 ] 1522 1522 2806 + 2807 +== (% style="color:#000000; font-size:16px" %)**Создание уведомления**(%%) == 2808 + 2809 +(% class="box infomessage" %) 2810 +((( 2811 +**POST /api/v3/notifications** 2812 +))) 2813 + 2814 +Метод запроса **POST** 2815 + 2816 +(% style="text-align: left;" %) 2817 +(% style="color:#000000" %)Пример запроса 2818 + 2819 +((( 2820 +{ 2821 + "id": 0, ~/~/ ID правила 2822 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2823 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2824 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2825 + "name": "string", ~/~/ Имя правила 2826 + "active": true, ~/~/ Активность правила 2827 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2828 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2829 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2830 + ], 2831 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2832 + 0 2833 + ], 2834 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2835 + 0 2836 + ], 2837 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2838 + 0 2839 + ], 2840 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2841 + "additionalProp1": "string", 2842 + "additionalProp2": "string", 2843 + "additionalProp3": "string" 2844 + }, 2845 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2846 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2847 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2848 + ], 2849 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2850 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2851 + "string" 2852 + ], 2853 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2854 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2855 + { 2856 + "id": 0, ~/~/ Идентификатор участника чата. 2857 + "info": "string" ~/~/ Дополнительные сведения. 2858 + } 2859 + ], 2860 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2861 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2862 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2863 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2864 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2865 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2866 + "timezone": 0, ~/~/ часовой пояс 2867 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2868 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2869 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2870 + { 2871 + "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 - Срок действия правила истек 2872 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2873 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2874 + "additionalProp1": "string", 2875 + "additionalProp2": "string", 2876 + "additionalProp3": "string" 2877 + } 2878 + } 2879 + ] 2880 +} 2881 +))) 2882 + 2883 +((( 2884 + 2885 +))) 2886 + 2887 +((( 2888 + 2889 +))) 2890 + 2891 +Ответ: 2892 + 2893 +{ 2894 + "id": 0, ~/~/ ID правила 2895 + "type": 0, ~/~/ Шаблон события 0 - Въезд и выезд из геозоны, 2 - Превышение скорости, 4 - Слив, 5 - Заправка, 6 - Сработка тревожной кнопки, 7 - Потеря связи с объектом, 8 - Сработка дискретного датчика, 9 - Значение аналогового датчика, 10 - Адрес, 11 - Простой, 12 - Выполнение ТО, 13 - Назначение водителя 2896 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Пользователь, создавший правило 2897 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 2898 + "name": "string", ~/~/ Имя правила 2899 + "active": true, ~/~/ Активность правила 2900 + "vehicleSource": 0, ~/~/ Определяет вид источника объектов для анализа. Если значение равно 0, то объекты. Если значение равно 1, то группы объекто 2901 + "vehicleGroups": [ ~/~/ Список групп объектов для анализа. 2902 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ 2903 + ], 2904 + "vehicleIds": [ ~/~/ Список объектов для анализа. 2905 + 0 2906 + ], 2907 + "geoids": [ ~/~/ Список идентификаторов гео-объектов, в которых проводить анализ по объектам. 2908 + 0 2909 + ], 2910 + "fieldids": [ ~/~/ Список идентификаторов полей, в которых проводить анализ по объектам. 2911 + 0 2912 + ], 2913 + "settings": { ~/~/ Определяет класс расширенных параметров правила уведомлений. 2914 + "additionalProp1": "string", 2915 + "additionalProp2": "string", 2916 + "additionalProp3": "string" 2917 + }, 2918 + "toEmail": true, ~/~/ Флаг, что активна настройка "Отправка уведомлений на эл. почту пользователям системы" 2919 + "recipientIds": [ ~/~/ Список Guid пользователей, которым надо отправить сообщение на почту при срабатывании правила 2920 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 2921 + ], 2922 + "enableSideEmails": true, ~/~/ Флаг, что активна настройка "Отправка сообщений на эл. почту сторонним пользователям" 2923 + "sideEmails": [ ~/~/ Список электронных адресов для отсылки уведомлений 2924 + "string" 2925 + ], 2926 + "toTelegram": true, ~/~/ Флаг активности отправки в Telegram 2927 + "telegrams": [ ~/~/ Список получателя уведомлений в Telegram. 2928 + { 2929 + "id": 0, ~/~/ Идентификатор участника чата. 2930 + "info": "string" ~/~/ Дополнительные сведения. 2931 + } 2932 + ], 2933 + "toMobile": true, ~/~/ Флаг активности отправки в мобильное приложение 2934 + "toClient": true, ~/~/ Флаг активности отправки в интерфейсе системы 2935 + "stored": true, ~/~/ Определяет необходимость сохранять уведомления, производные от этого правила, в журнале истории уведомлений. 2936 + "kind": 0, ~/~/ Определяет вид уведомления (0 - Информация, 1 - Подтверждение) 2937 + "activationMode": 0, ~/~/ Вид активации правила (0 - сейчас, 1 - ко времени) 2938 + "activationTime": "2025-06-09T13:21:13.669Z", ~/~/ Дата/время активации правила (UTC) 2939 + "timezone": 0, ~/~/ часовой пояс 2940 + "validity": 0, ~/~/ Срок действия в днях (1-90). 2941 + "autoProlongation": true, ~/~/ Автопродление срока действия. 2942 + "templates": [ ~/~/ Переопределения шаблонов уведомлений. 2943 + { 2944 + "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 - Срок действия правила истек 2945 + "override": true, ~/~/ Определяет необходимость переопределения шаблона уведомления определенного типа. 2946 + "parameters": { ~/~/ Определяет параметры шаблона уведомлений. "subject" и "textcontent" определяют тему и тело сообщения по умолчанию, "subject_{langid}" и "textcontent_{langid}" определяет тему и тело сообщения для определенного языка, где langid - идентификатор языка. 2947 + "additionalProp1": "string", 2948 + "additionalProp2": "string", 2949 + "additionalProp3": "string" 2950 + } 2951 + } 2952 + ] 2953 +} 2954 + 1523 1523 == (% style="color:#000000; font-size:16px" %)**Запрос настроек уведомления**(%%) == 1524 1524 1525 1525 (% class="box infomessage" %) ... ... @@ -1661,6 +1661,32 @@ 1661 1661 1662 1662 Success 1663 1663 3096 + 3097 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 3098 + 3099 +(% class="box warningmessage" %) 3100 +((( 3101 +**PUT** /api/v3/notifications/prolongation 3102 +))) 3103 + 3104 +Метод позволяет продлить уведомления. 3105 + 3106 +Метод запроса **PUT** 3107 + 3108 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 3109 + 3110 +В заголовках запроса: X-Auth: Токен авторизации. 3111 + 3112 +Тело запроса: 3113 + 3114 +[ 3115 + 3116 +0 3117 + 3118 +] 3119 + 3120 +где 0 идентификатор ids. 3121 + 1664 1664 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 1665 1665 1666 1666 (% class="box errormessage" %) ... ... @@ -1682,6 +1682,3456 @@ 1682 1682 1683 1683 Success 1684 1684 3143 + 3144 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Водители**(%%) = 3145 + 3146 +== (% style="color:#000000; font-size:16px" %)**Получить список водителей клиента**(%%) == 3147 + 3148 +(% class="box infomessage" %) 3149 +((( 3150 +**POST /api/v3/Drivers/find** 3151 +))) 3152 + 3153 +Передается параметр: parentId - ID клиента-родителя 3154 + 3155 +Ответ: 3156 + 3157 +[ 3158 + { 3159 + "name": "string", ~/~/ Определяет наименование 3160 + "description": "string", ~/~/ Определяет описание 3161 + "hiredate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату найма 3162 + "chopdate": "2023-06-30T09:37:58.407Z", ~/~/ Определяет дату увольнения 3163 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3165 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3166 + "deleted": true ~/~/ Признак удаления 3167 + } 3168 +] 3169 + 3170 +== (% style="color:#000000; font-size:16px" %)**Получить данные о водителе**(%%) == 3171 + 3172 +(% class="box infomessage" %) 3173 +((( 3174 +**GET /api/v3/Drivers/{driverGuid}** 3175 +))) 3176 + 3177 +Передается параметр: ID водителя 3178 + 3179 +Ответ: 3180 + 3181 +{ 3182 + "name": "string", ~/~/ Определяет наименование 3183 + "description": "string", ~/~/ Определяет описание 3184 + "hiredate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату найма 3185 + "chopdate": "2023-06-30T09:33:33.083Z", ~/~/ Определяет дату увольнения 3186 + "exclusive": true, ~/~/ Определяет признак "Исключительный" 3187 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID водителя 3188 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 3189 + "deleted": true ~/~/ Признак удаления 3190 +} 3191 + 3192 +== (% style="color:#000000; font-size:16px" %)**Добавить водителя**(%%) == 3193 + 3194 +(% class="box successmessage" %) 3195 +((( 3196 +**POST /api/v3/Drivers** 3197 +))) 3198 + 3199 +Запрос: 3200 + 3201 +{ 3202 + "name": "string", 3203 + "description": "string", 3204 + "hiredate": "2023-06-30T12:50:54.020Z", 3205 + "chopdate": "2023-06-30T12:50:54.020Z", 3206 + "exclusive": true, 3207 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3208 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3209 + "deleted": true 3210 +} 3211 + 3212 +Ответ: 3213 + 3214 +{ 3215 + "name": "string", 3216 + "description": "string", 3217 + "hiredate": "2023-06-30T12:50:54.051Z", 3218 + "chopdate": "2023-06-30T12:50:54.051Z", 3219 + "exclusive": true, 3220 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3221 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3222 + "deleted": true 3223 +} 3224 + 3225 + 3226 +== (% style="color:#000000; font-size:16px" %)**Редактировать водителя**(%%) == 3227 + 3228 +(% class="box warningmessage" %) 3229 +((( 3230 +**PUT /api/v3/Drivers** 3231 +))) 3232 + 3233 +Запрос: 3234 + 3235 +{ 3236 + "name": "string", 3237 + "description": "string", 3238 + "hiredate": "2023-06-30T12:50:27.910Z", 3239 + "chopdate": "2023-06-30T12:50:27.910Z", 3240 + "exclusive": true, 3241 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3242 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3243 + "deleted": true 3244 +} 3245 + 3246 +Ответ: 3247 + 3248 +{ 3249 + "name": "string", 3250 + "description": "string", 3251 + "hiredate": "2023-06-30T12:50:27.929Z", 3252 + "chopdate": "2023-06-30T12:50:27.929Z", 3253 + "exclusive": true, 3254 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3255 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3256 + "deleted": true 3257 +} 3258 + 3259 + 3260 +== (% style="color:#000000; font-size:16px" %)**Удалить водителя**(%%) == 3261 + 3262 +(% class="box errormessage" %) 3263 +((( 3264 +**DELETE /api/v3/Drivers/{driverGuid}** 3265 +))) 3266 + 3267 +Передается параметр: ID водителя 3268 + 3269 +Ответ: 3270 + 3271 +Success 3272 + 3273 + 3274 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Журнал назначений**(%%) = 3275 + 3276 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение водителя на объект**(%%) == 3277 + 3278 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к водителю**(%%) === 3279 + 3280 +(% class="box infomessage" %) 3281 +((( 3282 +**POST /api/v3/DriversVehiclesAssignments/GetByDrivers** 3283 +))) 3284 + 3285 +Запрос: 3286 + 3287 +{ 3288 + "Ids": [ 3289 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3290 + ], 3291 + "BeginTime": "2023-06-30T12:49:04.365Z", 3292 + "EndTime": "2023-06-30T12:49:04.365Z" 3293 +} 3294 + 3295 +Ответ: 3296 + 3297 +[ 3298 + { 3299 + "VehicleId": 0, 3300 + "CreateTime": "2023-06-30T09:52:31.240Z", 3301 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3302 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3303 + "BeginTime": "2023-06-30T09:52:31.240Z", 3304 + "EndTime": "2023-06-30T09:52:31.240Z" 3305 + } 3306 +] 3307 + 3308 + 3309 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения водителей запросом к объекту**(%%) === 3310 + 3311 +(% class="box infomessage" %) 3312 +((( 3313 +**POST /api/v3/DriversVehiclesAssignments/GetByVehicles** 3314 +))) 3315 + 3316 +Запрос: 3317 + 3318 +{ 3319 + "Ids": [ 3320 + 0 3321 + ], 3322 + "BeginTime": "2023-06-30T12:48:39.419Z", 3323 + "EndTime": "2023-06-30T12:48:39.419Z" 3324 +} 3325 + 3326 +Ответ: 3327 + 3328 +[ 3329 + { 3330 + "VehicleId": 0, 3331 + "CreateTime": "2023-06-30T09:54:01.631Z", 3332 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3333 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3334 + "BeginTime": "2023-06-30T09:54:01.631Z", 3335 + "EndTime": "2023-06-30T09:54:01.631Z" 3336 + } 3337 +] 3338 + 3339 + 3340 +=== (% style="color:#000000; font-size:16px" %)**Создать назначение водителя на объект**(%%) === 3341 + 3342 +(% class="box successmessage" %) 3343 +((( 3344 +**POST /api/v3/DriversVehiclesAssignments** 3345 +))) 3346 + 3347 +Передается массив назначений 3348 + 3349 +Запрос: 3350 + 3351 +[ 3352 + { 3353 + "VehicleId": 0, ~/~/ Идентификатор объекта 3354 + "CreateTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени создания назначения 3355 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3356 + "BeginTime": "2023-06-30T11:04:46.902Z", ~/~/ Момент времени начала назначения 3357 + "EndTime": "2023-06-30T11:04:46.902Z" ~/~/ Момент времени окончания назначения. Необязательно. 3358 + } 3359 +] 3360 + 3361 +Ответ: 3362 + 3363 +[ 3364 + { 3365 + "VehicleId": 0, 3366 + "CreateTime": "2023-06-30T11:04:46.903Z", 3367 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3368 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3369 + "BeginTime": "2023-06-30T11:04:46.903Z", 3370 + "EndTime": "2023-06-30T11:04:46.903Z" 3371 + } 3372 +] 3373 + 3374 + 3375 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения водителей на объекты**(%%) === 3376 + 3377 +(% class="box warningmessage" %) 3378 +((( 3379 +**PUT /api/v3/DriversVehiclesAssignments** 3380 +))) 3381 + 3382 +Запрос: 3383 + 3384 +[ 3385 + { 3386 + "VehicleId": 0, 3387 + "CreateTime": "2023-06-30T11:14:08.117Z", 3388 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3389 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3390 + "BeginTime": "2023-06-30T11:14:08.117Z", 3391 + "EndTime": "2023-06-30T11:14:08.117Z" 3392 + } 3393 +] 3394 + 3395 +Ответ: 3396 + 3397 +[ 3398 + { 3399 + "VehicleId": 0, 3400 + "CreateTime": "2023-06-30T11:14:53.349Z", 3401 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3402 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3403 + "BeginTime": "2023-06-30T11:14:53.349Z", 3404 + "EndTime": "2023-06-30T11:14:53.349Z" 3405 + } 3406 +] 3407 + 3408 + 3409 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения водителей на объекты**(%%) === 3410 + 3411 +(% class="box errormessage" %) 3412 +((( 3413 +**DELETE /api/v3/DriversVehiclesAssignments** 3414 +))) 3415 + 3416 +Запрос: 3417 + 3418 +[ 3419 + "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3420 +] 3421 + 3422 +Ответ: 3423 + 3424 +Success 3425 + 3426 + 3427 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение карты-метки водителю**(%%) == 3428 + 3429 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к водителю**(%%) === 3430 + 3431 +(% class="box infomessage" %) 3432 +((( 3433 +**POST /api/v3/DriversRfidsAssignments/GetByDrivers** 3434 +))) 3435 + 3436 +Запрос: 3437 + 3438 +{ 3439 + "Ids": [ 3440 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3441 + ], 3442 + "BeginTime": "2023-06-30T12:47:12.162Z", 3443 + "EndTime": "2023-06-30T12:47:12.162Z" 3444 +} 3445 + 3446 +Ответ: 3447 + 3448 +[ 3449 + { 3450 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3451 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3452 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3453 + "BeginTime": "2023-06-30T11:19:40.703Z", 3454 + "EndTime": "2023-06-30T11:19:40.703Z" 3455 + } 3456 +] 3457 + 3458 + 3459 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения меток запросом к карте-метке**(%%) === 3460 + 3461 +(% class="box infomessage" %) 3462 +((( 3463 +**POST /api/v3/DriversRfidsAssignments/GetByRfids** 3464 +))) 3465 + 3466 +Запрос: 3467 + 3468 +{ 3469 + "Ids": [ 3470 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3471 + ], 3472 + "BeginTime": "2023-06-30T12:47:12.162Z", 3473 + "EndTime": "2023-06-30T12:47:12.162Z" 3474 +} 3475 + 3476 +Ответ: 3477 + 3478 +[ 3479 + { 3480 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор метки 3481 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения 3482 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 3483 + "BeginTime": "2023-06-30T11:19:40.703Z", 3484 + "EndTime": "2023-06-30T11:19:40.703Z" 3485 + } 3486 +] 3487 + 3488 + 3489 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначения меток на водителей**(%%) === 3490 + 3491 +(% class="box successmessage" %) 3492 +((( 3493 +**POST /api/v3/DriversRfidsAssignments** 3494 +))) 3495 + 3496 +Запрос: 3497 + 3498 +[ 3499 + { 3500 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3501 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3502 + "BeginTime": "2023-06-30T11:27:08.635Z", 3503 + "EndTime": "2023-06-30T11:27:08.635Z" 3504 + } 3505 +] 3506 + 3507 +Ответ: 3508 + 3509 +[ 3510 + { 3511 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3512 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3513 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3514 + "BeginTime": "2023-06-30T11:27:08.677Z", 3515 + "EndTime": "2023-06-30T11:27:08.677Z" 3516 + } 3517 +] 3518 + 3519 + 3520 +=== (% style="color:#000000; font-size:16px" %)**Изменить назначения меток на водителей**(%%) === 3521 + 3522 +(% class="box warningmessage" %) 3523 +((( 3524 +**PUT /api/v3/DriversRfidsAssignments** 3525 +))) 3526 + 3527 +Запрос: 3528 + 3529 +[ 3530 + { 3531 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3532 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3533 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3534 + "BeginTime": "2023-06-30T11:28:43.330Z", 3535 + "EndTime": "2023-06-30T11:28:43.330Z" 3536 + } 3537 +] 3538 + 3539 +Ответ: 3540 + 3541 +[ 3542 + { 3543 + "Rfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3544 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3545 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3546 + "BeginTime": "2023-06-30T11:28:43.331Z", 3547 + "EndTime": "2023-06-30T11:28:43.331Z" 3548 + } 3549 +] 3550 + 3551 + 3552 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначения меток на водителей**(%%) === 3553 + 3554 +(% class="box errormessage" %) 3555 +((( 3556 +**DELETE /api/v3/DriversRfidsAssignments** 3557 +))) 3558 + 3559 +Запрос: 3560 + 3561 +[ 3562 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3563 +] 3564 + 3565 +Ответ: 3566 + 3567 +Success 3568 + 3569 + 3570 +== (% style="color:#000000; font-size:18.6667px" %)**Назначение топливной карты водителю**(%%) == 3571 + 3572 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к водителю**(%%) === 3573 + 3574 +(% class="box infomessage" %) 3575 +((( 3576 +**POST /api/v3/DriversFuelCardsAssignments/GetByDrivers** 3577 +))) 3578 + 3579 +Запрос: 3580 + 3581 +{ 3582 + "Ids": [ 3583 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3584 + ], 3585 + "BeginTime": "2023-06-30T12:45:10.852Z", 3586 + "EndTime": "2023-06-30T12:45:10.852Z" 3587 +} 3588 + 3589 +Ответ: 3590 + 3591 +[ 3592 + { 3593 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3594 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3595 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3596 + "BeginTime": "2023-06-30T11:58:04.695Z", 3597 + "EndTime": "2023-06-30T11:58:04.695Z" 3598 + } 3599 +] 3600 + 3601 + 3602 +=== (% style="color:#000000; font-size:16px" %)**Получить назначения топливных карт запросом к топливной карте**(%%) === 3603 + 3604 +(% class="box infomessage" %) 3605 +((( 3606 +**POST /api/v3/DriversFuelCardsAssignments/GetByCards** 3607 +))) 3608 + 3609 +Запрос: 3610 + 3611 +{ 3612 + "Ids": [ 3613 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3614 + ], 3615 + "BeginTime": "2023-06-30T12:45:10.852Z", 3616 + "EndTime": "2023-06-30T12:45:10.852Z" 3617 +} 3618 + 3619 +Ответ: 3620 + 3621 +[ 3622 + { 3623 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3624 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3625 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3626 + "BeginTime": "2023-06-30T11:58:04.695Z", 3627 + "EndTime": "2023-06-30T11:58:04.695Z" 3628 + } 3629 +] 3630 + 3631 + 3632 +=== (% style="color:#000000; font-size:16px" %)**Добавить назначение топливной карты водителю**(%%) === 3633 + 3634 +(% class="box successmessage" %) 3635 +((( 3636 +**POST /api/v3/DriversFuelCardsAssignments** 3637 +))) 3638 + 3639 +Запрос: 3640 + 3641 +[ 3642 + { 3643 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3644 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3645 + "BeginTime": "2023-06-30T12:09:53.175Z", 3646 + "EndTime": "2023-06-30T12:09:53.175Z" 3647 + } 3648 +] 3649 + 3650 +Ответ: 3651 + 3652 +[ 3653 + { 3654 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3655 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3656 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3657 + "BeginTime": "2023-06-30T12:09:53.201Z", 3658 + "EndTime": "2023-06-30T12:09:53.201Z" 3659 + } 3660 +] 3661 + 3662 + 3663 +=== (% style="color:#000000; font-size:16px" %)**Редактировать назначение топливной карты водителю**(%%) === 3664 + 3665 +(% class="box warningmessage" %) 3666 +((( 3667 +**PUT /api/v3/DriversFuelCardsAssignments** 3668 +))) 3669 + 3670 +Запрос: 3671 + 3672 +[ 3673 + { 3674 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3675 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3676 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3677 + "BeginTime": "2023-06-30T12:09:53.201Z", 3678 + "EndTime": "2023-06-30T12:09:53.201Z" 3679 + } 3680 +] 3681 + 3682 +Ответ: 3683 + 3684 +[ 3685 + { 3686 + "CardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3687 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3688 + "DriverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3689 + "BeginTime": "2023-06-30T12:09:53.201Z", 3690 + "EndTime": "2023-06-30T12:09:53.201Z" 3691 + } 3692 +] 3693 + 3694 + 3695 +=== (% style="color:#000000; font-size:16px" %)**Удалить назначение топливной карты водителю**(%%) === 3696 + 3697 +(% class="box errormessage" %) 3698 +((( 3699 +**DELETE /api/v3/DriversFuelCardsAssignments** 3700 +))) 3701 + 3702 +Запрос: 3703 + 3704 +[ 3705 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3706 +] 3707 + 3708 +Ответ: 3709 + 3710 +Success 3711 + 3712 + 3713 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3714 + 3715 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3716 + 3717 +(% class="box infomessage" %) 3718 +((( 3719 +**POST /api/v3/Trailers** 3720 +))) 3721 + 3722 +Пример запроса: 3723 + 3724 +{ 3725 + "startDate": "2023-11-14T10:48:03.671Z", 3726 + "endDate": "2023-11-14T10:48:03.671Z", 3727 + "ids": [ 0 ], 3728 + "timezone": 0 3729 +} 3730 + 3731 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3732 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3733 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3734 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3735 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3736 + 3737 +Пример ответа: 3738 + 3739 +[ 3740 + { 3741 + "SD": "2023-11-14T10:48:03.717Z", 3742 + "ED": "2023-11-14T10:48:03.717Z", 3743 + "id": 0, 3744 + "SLat": 0, 3745 + "SLon": 0, 3746 + "ELat": 0, 3747 + "ELon": 0, 3748 + "mileage": 0 3749 + "Duration": 0 3750 + "Address": "string", 3751 + "Address2": "string", 3752 + "name": "string", 3753 + "rid": "string", 3754 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3755 + "trailer": { 3756 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3757 + "Number": "string", 3758 + "Description": "string", 3759 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3760 + "ExternalID": "string", 3761 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3762 + "CreateTime": "2023-11-14T10:48:03.717Z", 3763 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3764 + "IsDeleted": true 3765 + }, 3766 + "filesCount": 0, 3767 + } 3768 +] 3769 + 3770 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3771 +|SD|Дата и время начала события 3772 +|ED|Дата и время окончания события 3773 +|id|ID объекта 3774 +|SLat|Широта начальной координаты 3775 +|SLon|Долгота начальной координаты 3776 +|ELat|Широта конечной координаты 3777 +|ELon|Долгота конечной координаты 3778 +|mileage|Пробег 3779 +|Duration|Продолжительность 3780 +|Address|Адрес начального местоположения 3781 +|Address2|Адрес конечного местоположения 3782 +|name|Имя радиометки 3783 +|rid|Номер радиометки 3784 +|rguid|ID радиометки 3785 +|trailer|Информация об агрегате 3786 +|ModelGuid|ID агрегата 3787 +|Number|Название/номер агрегата 3788 +|Description|Текст примечания агрегата 3789 + 3790 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 3791 + 3792 +== (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == 3793 + 3794 +(% class="box infomessage" %) 3795 +((( 3796 +**POST /api/v3/Rfids/find** 3797 +))) 3798 + 3799 +Запрос: 3800 + 3801 +{ 3802 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" 3803 +} 3804 + 3805 +Ответ: 3806 + 3807 +[ 3808 + { 3809 + "name": "string", 3810 + "number": 0, 3811 + "period": 0, 3812 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3813 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3814 + } 3815 +] 3816 + 3817 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3818 +|parentId|ID клиента 3819 +|name|Название карты-метки 3820 +|number|Номер 3821 +|period|Период запросов в секундах (работает только для агрегатов) 3822 +|id|ID карты-метки 3823 + 3824 +== (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 3825 + 3826 +(% class="box infomessage" %) 3827 +((( 3828 +**GET /api/v3/Rfids/{rfidGuid}** 3829 +))) 3830 + 3831 +Передаем параметр rfidGuid - идентификатор карты-метки 3832 + 3833 +Ответ: 3834 + 3835 +[ 3836 + { 3837 + "name": "string", 3838 + "number": 0, 3839 + "period": 0, 3840 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3841 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3842 + } 3843 +] 3844 + 3845 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3846 +|name|Название карты-метки 3847 +|number|Номер 3848 +|period|Период запросов в секундах (работает только для агрегатов) 3849 +|id|ID карты-метки 3850 +|parentId|ID клиента 3851 + 3852 +== (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 3853 + 3854 +(% class="box successmessage" %) 3855 +((( 3856 +**POST /api/v3/Rfids** 3857 +))) 3858 + 3859 +Запрос: 3860 + 3861 +{ 3862 + "name": "string", 3863 + "number": 0, 3864 + "period": 0, 3865 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3866 +} 3867 + 3868 +Ответ: 3869 + 3870 +{ 3871 + "name": "string", 3872 + "number": 0, 3873 + "period": 0, 3874 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3875 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3876 +} 3877 + 3878 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3879 +|name|Название карты-метки 3880 +|number|Номер 3881 +|period|Период запросов в секундах (работает только для агрегатов) 3882 +|id|ID карты-метки 3883 +|parentId|ID клиента 3884 + 3885 +== (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3886 + 3887 +(% class="box warningmessage" %) 3888 +((( 3889 +**PUT /api/v3/Rfids** 3890 +))) 3891 + 3892 +Запрос: 3893 + 3894 +{ 3895 + "name": "string", 3896 + "number": 0, 3897 + "period": 0, 3898 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3899 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3900 +} 3901 + 3902 +Ответ: 3903 + 3904 +{ 3905 + "name": "string", 3906 + "number": 0, 3907 + "period": 0, 3908 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3909 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3910 +} 3911 + 3912 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3913 +|name|Название карты-метки 3914 +|number|Номер 3915 +|period|Период запросов в секундах (работает только для агрегатов) 3916 +|id|ID карты-метки 3917 +|parentId|ID клиента 3918 + 3919 +== (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3920 + 3921 +(% class="box errormessage" %) 3922 +((( 3923 +**DELETE /api/v3/Rfids/{rfidGuid}** 3924 +))) 3925 + 3926 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3927 + 3928 +Ответ: 3929 + 3930 +Success 3931 + 3932 + 3933 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3934 + 3935 +== (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3936 + 3937 +(% class="box infomessage" %) 3938 +((( 3939 +**GET /api/v3/Billing/client/balance/{clientId}** 3940 +))) 3941 + 3942 +Параметр запроса: **clientId **- идентификатор клиента. 3943 + 3944 +Ответ: 3945 + 3946 +{ 3947 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3948 + "Balance": 0 3949 +} 3950 + 3951 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3952 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3953 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3954 + 3955 +== (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3956 + 3957 +(% class="box infomessage" %) 3958 +((( 3959 +**GET /api/v3/Billing/client/constraint/{clientId}** 3960 +))) 3961 + 3962 +Параметр запроса: **clientId **- идентификатор клиента. 3963 + 3964 +Ответ: 3965 + 3966 +{ 3967 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3968 + "CalculationType": 0, 3969 + "PermissibleBalance": 0, 3970 + "DefermentDays": 0, 3971 + "SendUiNotifications": true, 3972 + "SendEmailNotifications": true, 3973 + "IsPrivate": true, 3974 +} 3975 + 3976 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3977 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3978 +|(% style="width:215px" %)CalculationType|(% style="width:861px" %)Определяет тип расчёта, 0 - Деньги, 1 - Дни 3979 +|(% style="width:215px" %)PermissibleBalance|(% style="width:861px" %)Допустимый баланс 3980 +|(% style="width:215px" %)DefermentDays|(% style="width:861px" %)Отсрочка, количество дней. 3981 +|(% style="width:215px" %)SendUiNotifications|(% style="width:861px" %)Оповещение в web-интерфейсе, true - включено, false - выключено 3982 +|(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3983 +|(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3984 + 3985 +== (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3986 + 3987 +(% class="box infomessage" %) 3988 +((( 3989 +**GET /api/v3/Billing/client/plan/{clientId}** 3990 +))) 3991 + 3992 +Параметры запроса: 3993 + 3994 +**clientId **- идентификатор клиента. 3995 + 3996 +**planId **- идентификатор тарифного плана. 3997 + 3998 +Ответ: 3999 + 4000 +{ 4001 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4002 + "Plan": { **~/~/ Описание тарифного плана** 4003 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4004 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4005 + "Name": "string", 4006 + "IsArchived": true, 4007 + "Constraint": { 4008 + "CalculationType": 0, 4009 + "PermissibleBalance": 0, 4010 + "DefermentDays": 0 4011 + }, 4012 + "Features": [ **~/~/ Описание шаблона услуг тарифного плана** 4013 + { 4014 + "Feature": "string", 4015 + "IsFactual": true, 4016 + "Limit": 0, 4017 + "Price": 0, 4018 + "PeriodValue": 0, 4019 + "PeriodType": 0 4020 + } 4021 + ] 4022 + }, 4023 + "DebitDate": "2023-10-18T12:46:24.213Z", 4024 + "Features": [ **~/~/ Описание услуг тарифного плана как есть** 4025 + { 4026 + "Feature": "string", 4027 + "IsEnabled": true, 4028 + "IsPrivate": true, 4029 + "IsFactual": true, 4030 + "Limit": 0, 4031 + "Price": 0, 4032 + "DebitDate": "2023-10-18T12:46:24.213Z", 4033 + "PeriodValue": 0, 4034 + "PeriodType": 0 4035 + } 4036 + ] 4037 +} 4038 + 4039 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4040 +|ClientId|Идентификатор клиента 4041 +|Id|Идентификатор тарифного плана 4042 +|OwnerId|Идентификатор клиента-владельца 4043 +|Name|Наименование тарифного плана 4044 +|IsArchived|Признак, определяющий архивный тарифный план 4045 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4046 +|PermissibleBalance|Допустимый баланс 4047 +|DefermentDays|Отсрочка, количество дней 4048 +|Feature|Код услуги 4049 +|IsEnabled|Признак, определяющий активирована ли услуга 4050 +|IsPrivate|Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4051 +|IsFactual|Признак, определяющий расчёт по факту 4052 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4053 +|Price|Цена за единицу. 4054 +|DebitDate|Следующий момент времени списания с баланса за услугу. 4055 +|PeriodValue|Значение периода. 4056 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4057 + 4058 +== (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 4059 + 4060 +(% class="box infomessage" %) 4061 +((( 4062 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4063 +))) 4064 + 4065 +Параметр запроса: **clientId **- идентификатор клиента. 4066 + 4067 +Ответ: 4068 + 4069 +[ 4070 + { 4071 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4072 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4073 + "Name": "string", 4074 + "IsArchived": true, 4075 + "Constraint": { 4076 + "CalculationType": 0, 4077 + "PermissibleBalance": 0, 4078 + "DefermentDays": 0 4079 + }, 4080 + "Features": [ 4081 + { 4082 + "Feature": "string", 4083 + "IsFactual": true, 4084 + "Limit": 0, 4085 + "Price": 0, 4086 + "PeriodValue": 0, 4087 + "PeriodType": 0 4088 + } 4089 + ] 4090 + } 4091 +] 4092 + 4093 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4094 +|ClientId|Идентификатор клиента 4095 +|Id|Идентификатор тарифного плана 4096 +|OwnerId|Идентификатор клиента-владельца 4097 +|Name|Наименование тарифного плана 4098 +|IsArchived|Признак, определяющий архивный тарифный план 4099 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4100 +|PermissibleBalance|Допустимый баланс 4101 +|DefermentDays|Отсрочка, количество дней 4102 +|Feature|Код услуги 4103 +|IsFactual|Признак, определяющий расчёт по факту 4104 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4105 +|Price|Цена за единицу. 4106 +|PeriodValue|Значение периода. 4107 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4108 + 4109 +== (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 4110 + 4111 +(% class="box infomessage" %) 4112 +((( 4113 +**GET /api/v3/Billing/client/constraint/getowned/{clientId}** 4114 +))) 4115 + 4116 +Параметр запроса: **clientId **- идентификатор клиента. 4117 + 4118 +Ответ: 4119 + 4120 +[ 4121 + { 4122 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4123 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4124 + "Name": "string", 4125 + "IsArchived": true, 4126 + "Constraint": { 4127 + "CalculationType": 0, 4128 + "PermissibleBalance": 0, 4129 + "DefermentDays": 0 4130 + }, 4131 + "Features": [ 4132 + { 4133 + "Feature": "string", 4134 + "IsFactual": true, 4135 + "Limit": 0, 4136 + "Price": 0, 4137 + "PeriodValue": 0, 4138 + "PeriodType": 0 4139 + } 4140 + ] 4141 + } 4142 +] 4143 + 4144 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4145 +|ClientId|Идентификатор клиента 4146 +|Id|Идентификатор тарифного плана 4147 +|OwnerId|Идентификатор клиента-владельца 4148 +|Name|Наименование тарифного плана 4149 +|IsArchived|Признак, определяющий архивный тарифный план 4150 +|CalculationType|Определяет тип расчёта, 0 - Деньги, 1 - Дни 4151 +|PermissibleBalance|Допустимый баланс 4152 +|DefermentDays|Отсрочка, количество дней 4153 +|Feature|Код услуги 4154 +|IsFactual|Признак, определяющий расчёт по факту 4155 +|Limit|Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4156 +|Price|Цена за единицу. 4157 +|PeriodValue|Значение периода. 4158 +|PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 4159 + 4160 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4161 + 4162 +(% class="box warningmessage" %) 4163 +((( 4164 +**PUT /api/v3/Billing/client/balance** 4165 +))) 4166 + 4167 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4168 + 4169 +Тело запроса: 4170 + 4171 +{ 4172 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4173 + "Balance": 0 ~/~/ Значение баланса. 4174 +} 4175 + 4176 +Ответ: Success 4177 + 4178 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4179 + 4180 +(% class="box warningmessage" %) 4181 +((( 4182 +**PUT /api/v3/billing/client/balance/deposit** 4183 +))) 4184 + 4185 +Создает операцию **Пополнение **с указанной суммой 4186 + 4187 +Тело запроса: 4188 + 4189 +((( 4190 +{ 4191 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4192 + "amount": 0 ~/~/ Сумма пополнения баланса 4193 +} 4194 +))) 4195 + 4196 +((( 4197 + 4198 +))) 4199 + 4200 +Ответ: Success 4201 + 4202 +((( 4203 +{ 4204 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4205 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4206 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4207 + "Moment": "2025-06-10T12:15:19.076Z", ~/~/ Время корректировки. 4208 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4209 + "Description": "string" ~/~/ Описание корректировки. 4210 +} 4211 +))) 4212 + 4213 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4214 + 4215 +Создает операцию **Списание **с указанной суммой 4216 + 4217 +(% class="box warningmessage" %) 4218 +((( 4219 +**PUT /api/v3/billing/client/balance/withdraw** 4220 +))) 4221 + 4222 +Тело запроса: 4223 + 4224 +((( 4225 +{ 4226 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4227 + "amount": 0 ~/~/ Сумма списания с баланса 4228 +} 4229 +))) 4230 + 4231 +Ответ: Success 4232 + 4233 +((( 4234 +{ 4235 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор корректировки. 4236 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4237 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя. 4238 + "Moment": "2025-06-10T12:21:05.149Z", ~/~/ Время корректировки. 4239 + "Amount": 0, ~/~/ Значение, на которое корректируется баланс. 4240 + "Description": "string" ~/~/ Описание корректировки 4241 +} 4242 +))) 4243 + 4244 +== (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 4245 + 4246 +(% class="box warningmessage" %) 4247 +((( 4248 +**PUT /api/v3/Billing/client/constraint** 4249 +))) 4250 + 4251 +Тело запроса: 4252 + 4253 +((( 4254 +{ 4255 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4256 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4257 + "PermissibleBalance": 0, ~/~/ Допустимый баланс 4258 + "DefermentDays": 0, ~/~/ Отсрочка (дни). 4259 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4260 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4261 +} 4262 +))) 4263 + 4264 +((( 4265 + 4266 +))) 4267 + 4268 +Ответ: Success 4269 + 4270 +((( 4271 +{ 4272 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 4273 + "BlockingTime": "2025-06-10T12:23:28.754Z", ~/~/ Время, когда заблокируется клиент. 4274 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4275 + "CalculationType": 0, ~/~/ Определяет тип расчёта, 0 - Деньги, 1 - Дни 4276 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4277 + "DefermentDays": 0, ~/~/ Отсрочка (дни) 4278 + "SendUiNotifications": true, ~/~/ Оповещение в web-интерфейсе, true - включено, false - выключено 4279 + "SendEmailNotifications": true ~/~/ Оповещение на почту, true - включено, false - выключено 4280 +} 4281 +))) 4282 + 4283 +== (% style="color:#000000; font-size:16px" %)**Изменить тариф клиента**(%%) == 4284 + 4285 +(% class="box warningmessage" %) 4286 +((( 4287 +**PUT /api/v3/Billing/client/plan** 4288 +))) 4289 + 4290 +Тело запроса: 4291 + 4292 +{ 4293 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4294 + "PlanId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4295 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4296 + { 4297 + "Feature": "string", ~/~/ Код услуги. 4298 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4299 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4300 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование 4301 + "Price": 0, ~/~/ Цена за единицу. 4302 + "DebitDate": "2023-10-18T13:26:58.987Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4303 + "PeriodValue": 0, ~/~/ Значение периода. 4304 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане ( 0 - Дни, 1 - Месяцы) 4305 + } 4306 + ] 4307 +} 4308 + 4309 + 4310 +Ответ: Success 4311 + 4312 +((( 4313 +{ 4314 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 4315 + "Plan": { ~/~/ Определяет тарифный план (шаблон услуг) 4316 + "Id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор тарифного плана. 4317 + "OwnerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента-владельца. 4318 + "Name": "string", ~/~/ Наименование. 4319 + "IsArchived": true, ~/~/ Признак, определяющий архивный тарифный план. 4320 + "Constraint": { ~/~/ Ограничения по тарифу 4321 + "CalculationType": 0, ~/~/ Определяет тип расчёта (0 - деньги, 1 - дни) 4322 + "PermissibleBalance": 0, ~/~/ Допустимый баланс. 4323 + "DefermentDays": 0 ~/~/ Отсрочка (дни) 4324 + }, 4325 + "Features": [ ~/~/ Набор услуг по тарифному плану. 4326 + { 4327 + "Feature": "string", ~/~/Код услуги. 4328 + "IsFactual": true, ~/~/ Признак, определяющий возможность расчёта по факту. 4329 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4330 + "Price": 0, ~/~/ Цена за единицу. 4331 + "PeriodValue": 0, ~/~/ Значение периода. 4332 + "PeriodType": 0 ~/~/ Определяет тип периода действия услуги в тарифном плане. (0 - деньги, 1 - дни) 4333 + } 4334 + ], 4335 + "UserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, создавшего тарифный план. 4336 + "Created": "2025-06-10T12:29:32.969Z", ~/~/ Дата создания тарифного плана. 4337 + "Deactivated": "2025-06-10T12:29:32.969Z" ~/~/ Дата деактивации тарифного плана. 4338 + }, 4339 + "Features": [ ~/~/ Набор услуг по тарифу клиента. 4340 + { 4341 + "Feature": "string", ~/~/ Код услуги. 4342 + "IsEnabled": true, ~/~/ Признак, определяющий активирована ли услуга. 4343 + "IsPrivate": true, ~/~/ Признак, определяющий, являются ли параметры по услуге тарифа частными т.е. персональными для клиента, либо определяются тарифным планом. 4344 + "IsFactual": true, ~/~/ Признак, определяющий расчёт по факту. 4345 + "Limit": 0, ~/~/ Лимит использования услуги. Значение -1 подразумевает безлимитное использование. 4346 + "Price": 0, ~/~/ Цена за единицу. 4347 + "DebitDate": "2025-06-10T12:29:32.969Z", ~/~/ Следующий момент времени списания с баланса за услугу. 4348 + "PeriodValue": 0, ~/~/ Значение периода. 4349 + "PeriodType": 0, ~/~/ Определяет тип периода действия услуги в тарифном плане. 4350 + "Quantity": 0 ~/~/ Количество использования услуги. 4351 + } 4352 + ] 4353 +} 4354 +))) 4355 + 4356 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 4357 + 4358 +(% class="box warningmessage" %) 4359 +((( 4360 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4361 +))) 4362 + 4363 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4364 + 4365 +(% class="box infomessage" %) 4366 +((( 4367 +**POST /api/v3/vehicles/import/{agentId}** 4368 +))) 4369 + 4370 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4371 + 4372 +В пути указывается **agentId** - id клиента. 4373 + 4374 +**Заголовок** 4375 + 4376 +**X-Auth: [токен авторизации]** 4377 + 4378 +**Параметры** 4379 + 4380 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4381 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4382 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4383 + 4384 +В теле использовать тип **form-data,** тип значения** file** 4385 + 4386 +**Ключи** 4387 + 4388 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4389 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4390 +|csv|В значении передаем файл датчиков, формат **csv** 4391 + 4392 +Ответ: 4393 + 4394 +{ 4395 + "vehicleId": 0, 4396 + "name": "string", 4397 + "errors": ["string"] 4398 +} 4399 + 4400 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4401 +|vehicleId|ID созданного объекта 4402 +|name|Имя созданного объекта 4403 +|errors|Ошибки и их описание 4404 + 4405 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4406 + 4407 +(% class="box infomessage" %) 4408 +((( 4409 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4410 +))) 4411 + 4412 +(% class="wikigeneratedid" %) 4413 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4414 + 4415 +(% class="wikigeneratedid" %) 4416 +В пути указывается **vehicleId **- id объекта. 4417 + 4418 +**Заголовок** 4419 + 4420 +**X-Auth: [токен авторизации]** 4421 + 4422 +В теле использовать тип **form-data.** 4423 + 4424 +Ключи: 4425 + 4426 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4427 +|**history**|В значении передавать файл с историей 4428 + 4429 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4430 + 4431 +Ответ: 4432 + 4433 +{ 4434 + "results": [ 4435 + { 4436 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4437 + "vehicleId": 0, 4438 + "errors": [ 4439 + "string" 4440 + ], 4441 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4442 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4443 + "producedCount": 0, 4444 + "msgCount": 0 4445 + } 4446 + ] 4447 +} 4448 + 4449 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4450 +|results|Результаты импорта в разрезе ТС 4451 +|vehicleGuid|Guid ТС 4452 +|vehicleId|ID ТС 4453 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4454 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4455 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4456 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4457 +|msgCount|Кол-во обработанных сообщений всего 4458 + 4459 +== **Импортировать историю ТС (Асинхронный запрос)** == 4460 + 4461 +(% class="box successmessage" %) 4462 +((( 4463 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4464 +))) 4465 + 4466 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4467 + 4468 +Метод запроса: **POST** 4469 + 4470 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4471 + 4472 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4473 + 4474 + 4475 +Ответ: 4476 + 4477 +{ 4478 + 4479 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4480 + 4481 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4482 + 4483 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4484 + 4485 + "Message": "string", ~/~/ Информация о выполнении запроса 4486 + 4487 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4488 + 4489 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4490 + 4491 + "Data": "string" ~/~/ Данные 4492 + 4493 +} 4494 + 4495 + 4496 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4497 + 4498 +(% class="box infomessage" %) 4499 +((( 4500 +**GET /api/v3/vehicles/import/history/status** 4501 +))) 4502 + 4503 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4504 + 4505 +Ответ: 4506 + 4507 +{ 4508 + "activity": true, 4509 + "progress": 0, 4510 + "message": "string" 4511 +} 4512 + 4513 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4514 +**Параметр** 4515 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4516 +**Описание** 4517 +))) 4518 +|((( 4519 +activity 4520 +)))|((( 4521 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4522 +))) 4523 +|((( 4524 +progress 4525 +)))|((( 4526 +Guid ТС 4527 +))) 4528 + 4529 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4530 + 4531 +(% class="box infomessage" %) 4532 +((( 4533 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4534 +))) 4535 + 4536 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4537 + 4538 +Метод запроса: **GET** 4539 + 4540 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4541 + 4542 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4543 + 4544 + 4545 +Ответ: 4546 + 4547 +{ 4548 + 4549 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4550 + 4551 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4552 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4553 + 4554 + "Message": "string", ~/~/ Информация о выполнении запроса 4555 + 4556 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4557 + 4558 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4559 + 4560 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4561 + 4562 + "Data": "string" ~/~/ Данные 4563 + 4564 +} 4565 + 4566 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4567 + 4568 +(% class="box infomessage" %) 4569 +((( 4570 +**POST /api/v3/vehicles/export** 4571 +))) 4572 + 4573 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4574 + 4575 +Тело запроса: 4576 + 4577 +[ 4578 + id 4579 +] 4580 + 4581 +Ответ: Success 200, получаете файлы с настройками. 4582 + 4583 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4584 + 4585 +(% class="box infomessage" %) 4586 +((( 4587 +**POST /api/v3/vehicles/export/history** 4588 +))) 4589 + 4590 +Метод возвращает список сообщений терминала объекта за выбранный период. 4591 + 4592 +Тело запроса: 4593 + 4594 +{ 4595 + "vehicleId": 0, 4596 + "asArchive": true, 4597 + "from": "2023-09-27T12:17:45.973Z", 4598 + "to": "2023-09-27T12:17:45.973Z" 4599 +} 4600 + 4601 +Ответ: 4602 + 4603 +Получаете файл. Сообщение: Code 200/Success 4604 + 4605 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4606 +|vehicleId|ID объекта 4607 +|asArchive|true - Архивировать файл, False - не архивировать 4608 +|from|Дата и время начала запроса 4609 +|to|Дата и время окончания запроса 4610 + 4611 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4612 + 4613 +(% class="box infomessage" %) 4614 +((( 4615 +**GET /api/v3/vehicles/export/history/status** 4616 +))) 4617 + 4618 +Метод возвращает список сообщений терминала объекта за выбранный период. 4619 + 4620 +Ответ: 4621 + 4622 +{ 4623 + "activity": true, 4624 + "progress": 0, 4625 + "message": "string" 4626 +} 4627 + 4628 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4629 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4630 +|progress|Прогресс экспорта, от 0 до 100% 4631 +|message|Текст описывающий статус 4632 + 4633 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4634 + 4635 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4636 + 4637 +(% class="box infomessage" %) 4638 +((( 4639 +**POST /api/v3/EcoDriving/rating** 4640 +))) 4641 + 4642 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4643 + 4644 +Тело запроса: 4645 + 4646 +{ 4647 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4648 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4649 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4650 +} 4651 + 4652 +Ответ: 4653 + 4654 +{ 4655 + "items": [ ~/~/ Список в разрезе ТС 4656 + { 4657 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4658 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4659 + "vehicleId": 0, ~/~/ ID ТС 4660 + "vehicleName": "string", ~/~/ Название ТС 4661 + "vehicleModel": "string", ~/~/ Модель ТС 4662 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4663 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4664 + "totalViolations": 0, ~/~/ Нарушений всего 4665 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4666 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4667 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4668 + "brakingViolations": 0, ~/~/ Нарушений торможения 4669 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4670 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4671 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4672 + }, 4673 + 4674 +((( 4675 + 4676 +))) 4677 + 4678 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4679 + "mileage": 0, ~/~/ Пробег, м 4680 + "tripsCount": 0, ~/~/ Кол-во рейсов 4681 + "trips": [ ~/~/ Информация по рейсу 4682 + { 4683 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4684 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4685 + "violationsCount": 0, ~/~/ Всего нарушений 4686 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4687 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4688 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4689 + "brakingViolations": 0, ~/~/ Нарушений торможения 4690 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4691 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4692 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4693 + }, 4694 + 4695 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4696 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4697 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4698 + "mileage": 0, ~/~/ Пробег, м 4699 + "motohours": 0, ~/~/ Моточасы, секунды 4700 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4701 + "startAddress": "string", ~/~/ Адрес начала рейса 4702 + "endAddress": "string", ~/~/ Адрес конца рейса 4703 + "drivers": [ ~/~/ Список водителей 4704 + { 4705 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4706 + "driverName": "string", ~/~/ФИО водителя 4707 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4708 + } 4709 + ] 4710 + } 4711 + ] 4712 + } 4713 + ] 4714 +} 4715 + 4716 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4717 + 4718 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4719 + 4720 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4721 + 4722 +(% class="box infomessage" %) 4723 +((( 4724 +**POST /api/v3/fuelcards/transactions** 4725 +))) 4726 + 4727 +Метод запроса: POST 4728 + 4729 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4730 +\\В заголовках запроса: X-Auth: Токен авторизации 4731 + 4732 +Параметры в теле запроса (JSON): 4733 + 4734 +{ 4735 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4736 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4737 + "ids": [ 4738 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4739 + ], 4740 + "timezone": 0 ~/~/ Часовой пояс 4741 +} 4742 + 4743 + 4744 +Ответ: 4745 + { 4746 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4747 + "driver": "string", ~/~/ Водители, привязанные к ТК 4748 + "object": "string", ~/~/ Наименование ТС 4749 + "amount": 0, ~/~/ Количество топлива 4750 + "amountDut": 0, ~/~/ Количество по ДУТ 4751 + "amountDiff": 0, ~/~/ Разница, л 4752 + "amountDiffPerc": 0, ~/~/ Разница, % 4753 + "summa": 0, ~/~/ Стоимость, руб 4754 + "serviceName": "string", ~/~/ Тип топлива 4755 + "price": 0, ~/~/ Цена за литр, руб 4756 + "cardName": "string", ~/~/ Наименование ТК 4757 + "cardNum": "string", ~/~/ Номер ТК 4758 + "operator": "string", ~/~/ Оператор ТК 4759 + "address": "string" ~/~/ Адрес АЗС 4760 + } 4761 + 4762 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4763 + 4764 +(% class="box infomessage" %) 4765 +((( 4766 +**GET /api/v3/fuelcards** 4767 +))) 4768 + 4769 +Метод запроса: GET 4770 + 4771 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4772 + 4773 +Ответ: 4774 + 4775 +[ 4776 + { 4777 + "Name": "string", ~/~/ Определяет наименование карты. 4778 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4779 + "Number": "string", ~/~/ Определяет № карты. 4780 + "Enabled": true, ~/~/ Определяет признак активности карты. 4781 + "Description": "string", ~/~/ Определяет описание карты. 4782 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4783 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4784 + "deleted": true ~/~/ Признак удаления 4785 + } 4786 +] 4787 + 4788 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4789 + 4790 + 4791 +== **Получение полных данных о ретрансляторе** == 4792 + 4793 +(% class="box infomessage" %) 4794 +((( 4795 +**GET ** **/api/v3/retranslations/{id}** 4796 +))) 4797 + 4798 +id - Идентификатор ретранслятора 4799 + 4800 + 4801 +Пример ответа: 4802 + 4803 +{ 4804 +"description": "", ~/~/ Поле описания ретранслятора 4805 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4806 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4807 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4808 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4809 +"objects": [ ~/~/ Объекты для ретрансляции 4810 +{ 4811 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4812 +"name": "", ~/~/ Наименование объекта ретрансляции 4813 +"imei": "", ~/~/ IMEI объекта ретрансляции 4814 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4815 +} 4816 + ], 4817 +"id": "", ~/~/ Идентификатор ретранслятора 4818 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4819 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4820 +} 4821 + 4822 + 4823 +== **Удаление данных ретранслятора** == 4824 + 4825 +(% class="box infomessage" %) 4826 +((( 4827 +**DELETE** **/api/v3/retranslations/{id}** 4828 +))) 4829 + 4830 +id - Идентификатор ретранслятора 4831 + 4832 + 4833 +== **Создание ретранслятора** == 4834 + 4835 +(% class="box infomessage" %) 4836 +((( 4837 +**POST ** **/api/v3/retranslations/{id}** 4838 +))) 4839 + 4840 +Запрос: 4841 + 4842 +{ 4843 +"description": "", ~/~/ Поле описания ретранслятора 4844 +"subscriberId": "", ~/~/ Идентификатор подписчика 4845 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4846 +"address": "", ~/~/ Адрес и порт принимающего сервера 4847 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4848 +"objects": [ ~/~/Объекты для ретрансляции 4849 +{ 4850 +"id": "", ~/~/ Идентификатор ретранслятора 4851 +"imei": "", ~/~/ IMEI объекта ретрансляции 4852 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4853 +} 4854 + ] 4855 +} 4856 + 4857 + 4858 +Ответ: 4859 + 4860 +{ 4861 +"description": "", ~/~/ Поле описания ретранслятора 4862 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4863 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4864 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4865 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4866 +"objects": [ ~/~/ Объекты для ретрансляции 4867 +{ 4868 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4869 +"name": "string", ~/~/ Наименование объекта ретрансляции 4870 +"imei": "", ~/~/ IMEI объекта ретрансляции 4871 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4872 +} 4873 + ], 4874 +"id": "", ~/~/ Идентификатор ретранслятора 4875 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4876 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4877 +} 4878 + 4879 + 4880 +== **Редактирование ретранслятора** == 4881 + 4882 +(% class="box infomessage" %) 4883 +((( 4884 +**PUT** **/api/v3/retranslations** 4885 +))) 4886 + 4887 +Пример запроса: 4888 + 4889 +{ 4890 +"id": "", ~/~/ Идентификатор ретранслятора 4891 +"description": "string", ~/~/ Поле описания ретранслятора 4892 +"subscriberId": "", ~/~/ Идентификатор подписчика 4893 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4894 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4895 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4896 +"objects": ~/~/ Объекты для ретрансляции 4897 +[ 4898 +{ 4899 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4900 +"imei": "", ~/~/ IMEI объекта ретрансляции 4901 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4902 +} 4903 + ] 4904 +} 4905 + 4906 + 4907 +Пример ответа: 4908 + 4909 +{ 4910 +"description": "", ~/~/ Поле описания ретранслятора 4911 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4912 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4913 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4914 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4915 +"objects": [ ~/~/ Объекты для ретрансляции 4916 +{ 4917 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4918 +"name": "string", ~/~/ Наименование объекта ретрансляции 4919 +"imei": "", ~/~/ IMEI объекта ретрансляции 4920 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4921 +} 4922 + ], 4923 +"id": "", ~/~/ Идентификатор ретранслятора 4924 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4925 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4926 +} 4927 + 4928 + 4929 +== **Получение списка ретранслятора клиента** == 4930 + 4931 +(% class="box infomessage" %) 4932 +((( 4933 +**POST /api/v3/retranslations/find** 4934 +))) 4935 + 4936 +Пример запроса: 4937 + 4938 +{ 4939 +"id": "", ~/~/ Идентификатор ретранслятора 4940 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4941 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4942 +} 4943 + 4944 +Ответ: 4945 + 4946 +[ 4947 +{ 4948 +"description": "", ~/~/ Поле описания ретранслятора 4949 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4950 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4951 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4952 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4953 +"id": "", ~/~/ Идентификатор ретранслятора 4954 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4955 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4956 +} 4957 +] 4958 + 4959 + 4960 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4961 + 4962 +== **API для отчета по выгрузке комбайнов** == 4963 + 4964 +(% class="box infomessage" %) 4965 +((( 4966 +**POST /api/v3/Reports/harvesterUnloading** 4967 +))) 4968 + 4969 +Пример запроса: 4970 + 4971 +{ 4972 + "byTime": 0, ~/~/ Объединение событий по времени 4973 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4974 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4975 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4976 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4977 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4978 + 0 4979 + ], 4980 + "from": "", ~/~/ Дата и время начало запроса 4981 + "to": "", ~/~/ Дата и время окончания запроса 4982 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4983 +} 4984 + 4985 +Пример ответа: 4986 + 4987 +[ 4988 + { 4989 + "harvesterName": "", ~/~/Комбайн, номер 4990 + "harvesterId": 0, ~/~/Комбайн, id 4991 +"harvesterModel": "", ~/~/ Модель комбайна 4992 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4993 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4994 + "events": [ ~/~/Список событий в разрезе комбайна 4995 + { 4996 + "driverId": "", ~/~/Идентификатор водителя 4997 + "driverName": "", ~/~/Водитель комбайна, ФИО 4998 + "RFID": "", ~/~/ идентификатор карты-метки 4999 + "rfidName": "", ~/~/Водитель комбайна, имя метки 5000 + "vehicleId": 0, ~/~/идентификатор объекта 5001 + "vehicleName": "string", ~/~/ Имя объекта 5002 + "modelName": "string", ~/~/ Имя модели объекта 5003 + "nearestVehicles": [ ~/~/Объекты рядом 5004 + { 5005 + "vehicleId": 0, ~/~/идентификатор объекта 5006 + "vehicleName": "string" ~/~/ Имя объекта 5007 + } 5008 + ], 5009 + "fields": [ ~/~/Поля, где происходила выгрузка 5010 + { 5011 + "id": 0, ~/~/ идентификатор пользователя 5012 + "name": "string" ~/~/ имя пользователя 5013 + } 5014 + ], 5015 + "event": "string", ~/~/Событие 5016 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 5017 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 5018 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 5019 + "cultureName": "string", ~/~/ название культуры 5020 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 5021 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 5022 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 5023 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 5024 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 5025 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 5026 + "issued": 0, ~/~/Выдано, бункеров 5027 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 5028 + "latitude": 0, ~/~/Широта 5029 + "longitude": 0, ~/~/ Долгота 5030 + "litresAway": 0, ~/~/Отдано, л 5031 + "m3Away": 0 ~/~/Отдано, м3 5032 + } 5033 + ] 5034 + } 5035 +] 5036 + 5037 + 5038 +== **Отчет трек-датчики** == 5039 + 5040 +(% class="box infomessage" %) 5041 +((( 5042 +**POST /api/v3/Reports/sensorsWorks** 5043 +))) 5044 + 5045 +**Пример запроса:** 5046 + 5047 +{ 5048 + "vehicleIds": [ ~/~/ Список ID объектов 5049 + 0 5050 + ], 5051 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 5052 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 5053 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5054 +} 5055 + 5056 +**Пример ответа:** 5057 + 5058 +((( 5059 +{ 5060 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 5061 + { 5062 + "vehicleId": 0, ~/~/ Идентификатор ТС 5063 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 5064 + { 5065 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 5066 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 5067 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 5068 + "name": "string", ~/~/ Наименование оборудования. 5069 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 5070 + "totalMileage": 0, ~/~/ Общий пробег. 5071 + "avgSpeed": 0 ~/~/ Средняя скорость. 5072 + } 5073 + ] 5074 + } 5075 + ] 5076 +} 5077 + 5078 + 5079 +== **Превышение скорости** == 5080 + 5081 +(% class="box infomessage" %) 5082 +((( 5083 +**POST /api/v3/Reports/overSpeedDuration** 5084 +))) 5085 + 5086 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 5087 + 5088 +Пример запроса: 5089 + 5090 +((( 5091 +{ 5092 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 5093 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 5094 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 5095 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 5096 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 5097 +} 5098 +))) 5099 + 5100 +((( 5101 + 5102 +))) 5103 + 5104 +((( 5105 +Пример ответа: 5106 +))) 5107 + 5108 +((( 5109 +((( 5110 +[ 5111 + { 5112 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 5113 + "duration": 0, ~/~/ Продолжительность события в секундах 5114 + "maxSpeed": 0, ~/~/ Максимальная скорость 5115 + "speedLimit": 0 ~/~/ Ограничение скорости 5116 + } 5117 +] 5118 +))) 5119 +))) 5120 +))) 5121 + 5122 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 5123 + 5124 + 5125 +== **Запрос списка полей** == 5126 + 5127 +(% class="box successmessage" %) 5128 +((( 5129 +**POST /api/v3/agroLands/find** 5130 +))) 5131 + 5132 +Пример запроса: 5133 + 5134 +((( 5135 +((( 5136 +((( 5137 +{ 5138 + "year": 0, ~/~/ Фильтр по году 5139 + "name": "string", ~/~/ Фильтр по названию 5140 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 5141 +} 5142 +))) 5143 +))) 5144 + 5145 + 5146 +))) 5147 + 5148 +Пример ответа: 5149 + 5150 +((( 5151 +[ 5152 + { 5153 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5154 + "year": 0, ~/~/ Год поля 5155 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 5156 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 5157 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5158 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5159 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5160 + "counts": { ~/~/ Счётчики с/х поля 5161 + "fieldOperations": 0, ~/~/ Количество операций на поле 5162 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5163 + "facts": 0 ~/~/ Счётчик факта 5164 + }, 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 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5170 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5171 + "planComment": "string", ~/~/ Комментарий к полю 5172 + "productivity": 0, ~/~/ Урожайность. 5173 + "id": 0, ~/~/ Идентификатор объекта геозоны 5174 + "name": "string", ~/~/ Название объекта геозоны 5175 + "type": 0, ~/~/ Тип объекта геозоны 5176 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5177 + "fname": "string", ~/~/ Имя файла 5178 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5179 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 5180 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 5181 + "description": "string", ~/~/ Описание объекта геозоны 5182 + "area": 0, ~/~/ Площадь, м2 5183 + "perimetr": 0, ~/~/ Периметр, м 5184 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 5185 + } 5186 +] 5187 + 5188 + 5189 +== **Создание нового поля ** == 5190 + 5191 +(% class="box successmessage" %) 5192 +((( 5193 +**POST /api/v3/agroLands** 5194 +))) 5195 + 5196 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 5197 +X-agent - ID клиента 5198 + 5199 +Пример запроса: 5200 + 5201 +((( 5202 +{ 5203 + "extId": "string", 5204 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5205 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5206 + "display": "string", ~/~/ Настройки отображения 5207 + "year": 0, ~/~/ Год поля 5208 + "name": "string", ~/~/ Наименование 5209 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5210 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5211 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5212 + "planComment": "string", ~/~/ Комментарий к полю 5213 + "cropRotations": [ ~/~/ Данные по севообороту 5214 + { 5215 + "landId": 0, ~/~/ ID поля 5216 + "landName": "string", ~/~/ Название поля 5217 + "year": 0, ~/~/ Год урожая 5218 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5219 + "cultureName": "string", ~/~/ Название культуры 5220 + "productivity": 0, ~/~/ Урожайность 5221 + "area": 0, ~/~/ Площадь поля, Га 5222 + "total": 0, ~/~/ Валовый сбор 5223 + "productivityFact": 0, ~/~/ Фактическая урожайность 5224 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5225 + "totalFact": 0, ~/~/ Фактический валовый сбор 5226 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5227 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5228 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5229 + "isyearplan": true, ~/~/ Годовой план 5230 + "comment": "string" ~/~/ Комментарий 5231 + } 5232 + ] 5233 +} 5234 +))) 5235 + 5236 +((( 5237 + 5238 +))) 5239 + 5240 +Пример ответа: 5241 + 5242 +((( 5243 +((( 5244 +{ 5245 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5246 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5247 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5248 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5249 + "cropRotations": [ ~/~/ Данные по севообороту 5250 + { 5251 + "landId": 0, ~/~/ ID поля 5252 + "landName": "string", ~/~/ Название поля 5253 + "year": 0, ~/~/ Год урожая 5254 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5255 + "cultureName": "string", ~/~/ Название культуры 5256 + "productivity": 0, ~/~/ Урожайность 5257 + "area": 0, ~/~/ Площадь поля, Га. 5258 + "total": 0, ~/~/ Валовый сбор 5259 + "productivityFact": 0, ~/~/ Фактическая урожайность 5260 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5261 + "totalFact": 0, ~/~/ Фактический валовый сбор 5262 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5263 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5264 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5265 + "isyearplan": true, ~/~/ годовой план 5266 + "comment": "string" ~/~/ Комментарий 5267 + } 5268 + ], 5269 + "cropVegetation": [ ~/~/ История вегетации поля 5270 + { 5271 + "values": [ ~/~/ Данные вегетации и состояния посева 5272 + { 5273 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5274 + "ndvi": 0 ~/~/ Индекс вегетации 5275 + } 5276 + ], 5277 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5278 + { 5279 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5280 + "type": "string", ~/~/ Тип 5281 + "pictureid": "string" ~/~/ Идентификатор ресурса 5282 + } 5283 + ], 5284 + "states": [ ~/~/ Ключевые даты развития поля 5285 + { 5286 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5287 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5288 + } 5289 + ] 5290 + } 5291 + ], 5292 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5293 + "counts": { 5294 + "fieldOperations": 0, ~/~/ Количество операций на поле 5295 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5296 + "facts": 0 ~/~/ Счётчик факта 5297 + }, 5298 + "planComment": "string", ~/~/ Комментарий к полю 5299 +))) 5300 + 5301 +((( 5302 + "productivity": 0, ~/~/ Урожайность. 5303 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5304 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5305 + "year": 0, ~/~/ Год поля 5306 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5307 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5308 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5309 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5310 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5311 + "id": 0, ~/~/ Идентификатор объекта геозоны 5312 + "name": "string", ~/~/ Название объекта геозоны 5313 + "type": 0, ~/~/ Тип объекта геозоны 5314 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5315 + "fname": "string", ~/~/ Имя файла 5316 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5317 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5318 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5319 + "description": "string", ~/~/ Описание объекта геозоны 5320 + "area": 0, ~/~/ Площадь, м2 5321 + "perimetr": 0, ~/~/ Периметр, м 5322 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5323 +} 5324 + 5325 + 5326 +))) 5327 +))) 5328 +))) 5329 + 5330 +== **Получение поля по id** == 5331 + 5332 +(% class="box infomessage" %) 5333 +((( 5334 +**GET /api/v3/agroLands/{id}** 5335 +))) 5336 + 5337 +Пример запроса: 5338 +id ~/~/ Идентификатор поля 5339 + 5340 +Пример ответа: 5341 + 5342 +((( 5343 +{ 5344 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5345 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5346 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5347 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5348 + "cropRotations": [ ~/~/ Данные по севообороту 5349 + { 5350 + "landId": 0, ~/~/ ID поля 5351 + "landName": "string", ~/~/ Название поля 5352 + "year": 0, ~/~/ Год урожая 5353 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5354 + "cultureName": "string", ~/~/ Название культуры 5355 + "productivity": 0, ~/~/ Урожайность 5356 + "area": 0, ~/~/ Площадь поля, Га 5357 + "total": 0, ~/~/ Валовый сбор 5358 + "productivityFact": 0, ~/~/ Фактическая урожайность 5359 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5360 + "totalFact": 0, ~/~/ Фактический валовый сбор 5361 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5362 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5363 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5364 + "isyearplan": true, ~/~/ План года 5365 + "comment": "string" ~/~/ Комментарий 5366 + } 5367 + ], 5368 + "cropVegetation": [ ~/~/ История вегетации поля 5369 + { 5370 + "values": [ ~/~/ Данные вегетации и состояния посева 5371 + { 5372 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5373 + "ndvi": 0 ~/~/ Индекс вегетации 5374 + } 5375 + ], 5376 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5377 + { 5378 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5379 + "type": "string", ~/~/ Тип 5380 + "pictureid": "string" ~/~/ Идентификатор ресурса 5381 + } 5382 + ], 5383 + "states": [ ~/~/ Ключевые даты развития поля 5384 + { 5385 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5386 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5387 + } 5388 + ] 5389 + } 5390 + ], 5391 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5392 + "counts": { 5393 + "fieldOperations": 0, ~/~/ Количество операций на поле 5394 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5395 + "facts": 0 ~/~/ Счётчик факта 5396 + }, 5397 + "planComment": "string", ~/~/ Комментарий к полю 5398 + "productivity": 0, ~/~/ Урожайность. 5399 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5400 +))) 5401 + 5402 +((( 5403 +((( 5404 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5405 + "year": 0, ~/~/ Год поля 5406 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5407 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5408 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5409 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5410 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5411 + "id": 0, ~/~/ Идентификатор объекта геозоны 5412 + "name": "string", ~/~/ Название объекта геозоны 5413 + "type": 0, ~/~/ Тип объекта геозоны 5414 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5415 + "fname": "string", ~/~/ Имя файла 5416 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5417 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5418 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5419 + "description": "string", ~/~/ Описание объекта геозоны 5420 + "area": 0, ~/~/ Площадь, м2 5421 + "perimetr": 0, ~/~/ Периметр, м 5422 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5423 +} 5424 +))) 5425 + 5426 + 5427 +== **Удаление существующего поля** == 5428 + 5429 +(% class="box errormessage" %) 5430 +((( 5431 +**DELETE /api/v3/agroLands/{id}** 5432 +))) 5433 + 5434 +Пример запроса: 5435 +id ~/~/ Идентификатор поля 5436 + 5437 +Пример ответа: 5438 + 5439 +((( 5440 +200 ~/~/ Успех 5441 +))) 5442 + 5443 +((( 5444 + 5445 +))) 5446 + 5447 +((( 5448 +((( 5449 +((( 5450 + 5451 +))) 5452 + 5453 +((( 5454 +== **Изменение поля** == 5455 + 5456 +(% class="box infomessage" %) 5457 +((( 5458 +**PUT /api/v3/agroLands** 5459 +))) 5460 + 5461 +Пример запроса: 5462 + 5463 +((( 5464 +((( 5465 +{ 5466 + "id": 0, ~/~/ Идентификатор поля 5467 + "extId": "string", ~/~/ ExtId 5468 + "shape": "string", ~/~/ Форма поля 5469 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5470 + "display": "string", ~/~/ Настройки отображения 5471 + "year": 0, ~/~/ Год поля 5472 + "name": "string", ~/~/ Наименование 5473 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5474 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5475 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5476 + "planComment": "string", ~/~/Комментарий к полю 5477 + "cropRotations": [ ~/~/ Данные по севообороту 5478 + { 5479 + "landId": 0, ~/~/ ID поля 5480 + "landName": "string", ~/~/ Название поля 5481 + "year": 0, ~/~/ Год урожая 5482 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5483 + "cultureName": "string", ~/~/ Название культуры 5484 + "productivity": 0, ~/~/ Урожайность 5485 + "area": 0, ~/~/ Площадь поля, Га. 5486 + "total": 0, ~/~/ Валовый сбор 5487 + "productivityFact": 0, ~/~/ Фактическая урожайность 5488 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5489 + "totalFact": 0, ~/~/ Фактический валовый сбор 5490 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5491 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5492 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5493 + "isyearplan": true, 5494 + "comment": "string" ~/~/ Комментарий 5495 + } 5496 + ], 5497 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5498 +} 5499 +))) 5500 +))) 5501 + 5502 +((( 5503 + 5504 +))) 5505 + 5506 +Пример ответа: 5507 + 5508 +((( 5509 +((( 5510 +((( 5511 +{ 5512 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5513 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5514 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5515 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5516 + "cropRotations": [ ~/~/ Данные по севообороту 5517 + { 5518 + "landId": 0, ~/~/ ID поля 5519 + "landName": "string", ~/~/ Название поля 5520 + "year": 0, ~/~/ Год урожая 5521 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5522 + "cultureName": "string", ~/~/ Название культуры 5523 + "productivity": 0, ~/~/ Урожайность 5524 + "area": 0, ~/~/ Площадь поля, Га 5525 + "total": 0, ~/~/ Валовый сбор 5526 + "productivityFact": 0, ~/~/ Фактическая урожайность 5527 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5528 + "totalFact": 0, ~/~/ Фактический валовый сбор 5529 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5530 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5531 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5532 + "isyearplan": true, ~/~/ 5533 + "comment": "string" ~/~/ Комментарий 5534 + } 5535 + ], 5536 + "cropVegetation": [ ~/~/ История вегетации поля 5537 + { 5538 + "values": [ ~/~/ Данные вегетации и состояния посева 5539 + { 5540 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5541 + "ndvi": 0 ~/~/ Индекс вегетации 5542 + } 5543 + ], 5544 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5545 + { 5546 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5547 + "type": "string", ~/~/ Тип 5548 + "pictureid": "string" ~/~/ Идентификатор ресурса 5549 + } 5550 + ], 5551 + "states": [ ~/~/ Ключевые даты развития поля 5552 + { 5553 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5554 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5555 + } 5556 + ] 5557 + } 5558 + ], 5559 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5560 + "counts": { 5561 + "fieldOperations": 0, ~/~/ Количество операций на поле 5562 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5563 + "facts": 0 ~/~/ Счётчик факта 5564 + }, 5565 + "planComment": "string", ~/~/ Комментарий к полю 5566 + "productivity": 0, ~/~/ Урожайность. 5567 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5568 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5569 + "year": 0, ~/~/ Год поля 5570 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5571 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5572 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5573 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5574 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5575 + "id": 0, ~/~/ Идентификатор объекта геозоны 5576 + "name": "string", ~/~/ Название объекта геозоны 5577 + "type": 0, ~/~/ Тип объекта геозоны 5578 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5579 + "fname": "string", ~/~/ Имя файла 5580 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5581 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5582 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5583 + "description": "string", ~/~/ Описание объекта геозоны 5584 + "area": 0, ~/~/ Площадь, м2 5585 + "perimetr": 0, ~/~/ Периметр, м 5586 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5587 +} 5588 +))) 5589 +))) 5590 +))) 5591 +))) 5592 +))) 5593 + 5594 + 5595 +== **Редактирование года урожая ** == 5596 + 5597 +(% class="box successmessage" %) 5598 +((( 5599 +**POST /api/v3/agroLands/updateOpenCloseYear** 5600 +))) 5601 + 5602 +Пример запроса: 5603 + 5604 +((( 5605 +((( 5606 +{ 5607 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5608 + 0 5609 + ], 5610 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5611 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5612 +} 5613 +))) 5614 + 5615 + 5616 +))) 5617 + 5618 +Пример ответа: 5619 + 5620 +((( 5621 +((( 5622 +{ 5623 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5624 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5625 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5626 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5627 + "cropRotations": [ ~/~/ Данные по севообороту 5628 + { 5629 + "landId": 0, ~/~/ ID поля 5630 + "landName": "string", ~/~/ Название поля 5631 + "year": 0, ~/~/ Год урожая 5632 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5633 + "cultureName": "string", ~/~/ Название культуры 5634 + "productivity": 0, ~/~/ Урожайность 5635 + "area": 0, ~/~/ Площадь поля, Га. 5636 + "total": 0, ~/~/ Валовый сбор 5637 + "productivityFact": 0, ~/~/ Фактическая урожайность 5638 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5639 + "totalFact": 0, ~/~/ Фактический валовый сбор 5640 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5641 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5642 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5643 + "isyearplan": true, ~/~/ 5644 + "comment": "string" ~/~/ Комментарий 5645 + } 5646 + ], 5647 + "cropVegetation": [ ~/~/ История вегетации поля 5648 + { 5649 + "values": [ ~/~/ Данные вегетации и состояния посева 5650 + { 5651 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5652 + "ndvi": 0 ~/~/ Индекс вегетации 5653 + } 5654 + ], 5655 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5656 + { 5657 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5658 + "type": "string", ~/~/ Тип 5659 + "pictureid": "string" ~/~/ Идентификатор ресурса 5660 + } 5661 + ], 5662 + "states": [ ~/~/ Ключевые даты развития поля 5663 + { 5664 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5665 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5666 + } 5667 + ] 5668 + } 5669 + ], 5670 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5671 + "counts": { 5672 + "fieldOperations": 0, ~/~/ Количество операций на поле 5673 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5674 + "facts": 0 ~/~/ Счётчик факта 5675 + }, 5676 + "planComment": "string", ~/~/ Комментарий к полю 5677 + "productivity": 0, ~/~/ Урожайность. 5678 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5679 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5680 + "year": 0, ~/~/ Год поля 5681 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5682 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5683 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5684 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5685 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5686 + "id": 0, ~/~/ Идентификатор объекта геозоны 5687 + "name": "string", ~/~/ Название объекта геозоны 5688 + "type": 0, ~/~/ Тип объекта геозоны 5689 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5690 + "fname": "string", ~/~/ Имя файла 5691 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5692 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5693 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5694 + "description": "string", ~/~/ Описание объекта геозоны 5695 + "area": 0, ~/~/ Площадь, м2 5696 + "perimetr": 0, ~/~/ ериметр, м 5697 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5698 +} 5699 +))) 5700 + 5701 + 5702 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5703 +))) 5704 +))) 5705 +))) 5706 + 5707 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5708 + 5709 + 5710 +(% class="box infomessage" %) 5711 +((( 5712 +**GET api/v3/Vehicles/recyclebin/all** 5713 +))) 5714 + 5715 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5716 + 5717 +Параметр запроса: {parentId} - идентификатор агента 5718 + 5719 +В заголовках запроса: X-Auth: Токен авторизации 5720 + 5721 +Ответ: 5722 + 5723 +[ 5724 + { 5725 + "recordTime": "", ~/~/Время записи 5726 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5727 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5728 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5729 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5730 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5731 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5732 + "items": [ ~/~/ 5733 +nullable: true ~/~/Детали 5734 + { 5735 + "name": "string", ~/~/наименование столбца 5736 + "value": "string" ~/~/содержание столбца 5737 + } 5738 + ] 5739 + }, 5740 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5741 + "string" 5742 + ] 5743 + } 5744 +] 5745 + 5746 + 5747 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5748 + 5749 +(% class="box infomessage" %) 5750 +((( 5751 +**POST api/v3/Vehicles/recyclebin/erase** 5752 +))) 5753 + 5754 +В заголовках запроса: X-Auth: Токен авторизации 5755 + 5756 +Пример запроса: 5757 + 5758 +[ 5759 +0 5760 +] 5761 + 5762 + 5763 +Пример ответа: 5764 + 5765 +[ 5766 +{ 5767 + "recordTime": "", ~/~/Время записи 5768 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5769 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5770 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5771 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5772 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5773 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5774 + "items": [ ~/~/Детали 5775 + { 5776 + "name": "", ~/~/Имя свойства 5777 + "value": "" ~/~/Значение свойства 5778 + } 5779 + ] 5780 + }, 5781 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5782 + "" 5783 + ] 5784 + } 5785 +] 5786 + 5787 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5788 + 5789 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5790 + 5791 +(% class="box infomessage" %) 5792 +((( 5793 +**POST api/v3/Vehicles/recyclebin/restore** 5794 +))) 5795 + 5796 +В заголовках запроса: X-Auth: Токен авторизации 5797 + 5798 +Параметры в теле запроса (JSON): 5799 + 5800 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5801 + 5802 +В заголовках запроса: X-Auth: Токен авторизации 5803 + 5804 + 5805 +Пример запроса: 5806 + 5807 +((( 5808 +[ 5809 +))) 5810 + 5811 +((( 5812 + 0 5813 +))) 5814 + 5815 +((( 5816 +] 5817 +))) 5818 + 5819 + 5820 +Пример ответа: 5821 + 5822 +[ 5823 +{ 5824 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5825 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5826 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5827 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5828 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5829 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5830 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5831 + "items": [ ~/~/Детали 5832 + { 5833 + "name": "string", ~/~/Имя свойства 5834 + "value": "string" ~/~/Значение свойства 5835 + } 5836 + ] 5837 + }, 5838 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5839 + "string" 5840 + ] 5841 + } 5842 +] 5843 + 5844 + 5845 += **Раздел: Журнал заданий ** = 5846 + 5847 + 5848 +== **Создание задания в Журнале заданий** == 5849 + 5850 +(% class="box infomessage" %) 5851 +((( 5852 +**POST /api/v3/vehicletasks** 5853 +))) 5854 + 5855 +Пример запроса: 5856 + 5857 +((( 5858 +{ 5859 + "vehicleId": 0, ~/~/ Идентификатор ТС 5860 + "description": "string", ~/~/ Описание 5861 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5862 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5863 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5864 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5865 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5866 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5867 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5868 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5869 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5870 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5871 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5872 + "cost": { 5873 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5874 + "Name": "string", ~/~/ Наименование 5875 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5876 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5877 + "Norm": 0 ~/~/ Норма внесения 5878 + }, 5879 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5880 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5881 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5882 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5883 + "deleted": true, ~/~/ Признак удаления 5884 + "extId": "string", 5885 + "GeoIds": [ ~/~/ Cвязанные поля 5886 + 0 5887 + ] 5888 +} 5889 +))) 5890 + 5891 + 5892 +Пример ответа: 5893 + 5894 +{ 5895 + "vehicleId": 0, ~/~/ Идентификатор ТС 5896 + "description": "string", ~/~/ Описание 5897 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5898 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5899 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5900 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5901 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5902 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5903 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5904 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5905 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5906 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5907 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5908 + "cost": { 5909 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5910 + "Name": "string", ~/~/ Наименование 5911 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5912 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5913 + "Norm": 0 ~/~/ Норма внесения 5914 + }, 5915 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5916 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5917 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5918 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5919 + "deleted": true, ~/~/ Признак удаления 5920 + "extId": "string", ~/~/ ExtId 5921 + "GeoIds": [ ~/~/ Связанные поля 5922 + 0 5923 + ] 5924 +} 5925 + 5926 + 5927 +== **Редактирование задания в Журнале заданий** == 5928 + 5929 +(% class="box successmessage" %) 5930 +((( 5931 +**PUT /api/v3/vehicletasks** 5932 +))) 5933 + 5934 +Пример запроса: 5935 + 5936 +((( 5937 +{ 5938 + "vehicleId": 0, ~/~/ Идентификатор ТС 5939 + "description": "string", ~/~/ Описание 5940 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5941 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5942 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5943 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5944 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5945 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5946 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5947 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5948 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5949 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5950 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5951 + "cost": { 5952 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5953 + "Name": "string", ~/~/ Наименование 5954 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5955 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5956 + "Norm": 0 ~/~/ Норма внесения 5957 + }, 5958 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5959 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5960 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5961 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5962 + "deleted": true, ~/~/ Признак удаления 5963 + "extId": "string", ~/~/ ExtId 5964 + "GeoIds": [ ~/~/ Связанные поля 5965 + 0 5966 + ] 5967 +} 5968 +))) 5969 + 5970 + 5971 +Пример ответа: 5972 + 5973 +{ 5974 + "vehicleId": 0, ~/~/ Идентификатор ТС 5975 + "description": "string", ~/~/ Описание 5976 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5977 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5978 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5979 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5980 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5981 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5982 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5983 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5984 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5985 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5986 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5987 + "cost": { 5988 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5989 + "Name": "string", ~/~/ Наименование 5990 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5991 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5992 + "Norm": 0 ~/~/ Норма внесения 5993 + }, 5994 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5995 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5996 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5997 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5998 + "deleted": true, ~/~/ Признак удаления 5999 + "extId": "string", ~/~/ ExtId 6000 + "GeoIds": [ ~/~/ Связанные поля 6001 + 0 6002 + ] 6003 +} 6004 + 6005 + 6006 +== **Удаление задания в Журнале заданий** == 6007 + 6008 +(% class="box warningmessage" %) 6009 +((( 6010 +**DELETE /api/v3/vehicletasks** 6011 +))) 6012 + 6013 +Пример запроса: 6014 + 6015 +((( 6016 +[ 6017 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 6018 +] 6019 +))) 6020 + 6021 +((( 6022 + 6023 +))) 6024 + 6025 +Пример ответа: 6026 + 6027 +{ 6028 + "vehicleId": 0, ~/~/ Идентификатор ТС 6029 + "description": "string", ~/~/ Описание 6030 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 6031 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 6032 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 6033 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 6034 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 6035 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 6036 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 6037 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 6038 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 6039 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 6040 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 6041 + "cost": { 6042 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 6043 + "Name": "string", ~/~/ Наименование 6044 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 6045 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 6046 + "Norm": 0 ~/~/ Норма внесения 6047 + }, 6048 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6049 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 6050 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 6051 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 6052 + "deleted": true, ~/~/ Признак удаления 6053 + "extId": "string", ~/~/ ExtId 6054 + "GeoIds": [ ~/~/ Связанные поля 6055 + 0 6056 + ] 6057 +} 6058 + 6059 + 6060 +== **Получение списка Журнала заданий** == 6061 + 6062 +(% class="box infomessage" %) 6063 +((( 6064 +**POST /api/v3/vehicletasks/getbyperiod** 6065 +))) 6066 + 6067 +Пример запроса: 6068 + 6069 +((( 6070 +{ 6071 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 6072 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 6073 + "TimeZone": 0, ~/~/ Часовой пояс. 6074 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 6075 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 6076 + ], 6077 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 6078 + 0 6079 + ], 6080 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 6081 + 0 6082 + ], 6083 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 6084 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 6085 +} 6086 +))) 6087 + 6088 + 6089 +Пример ответа: 6090 + 6091 +((( 6092 +{ 6093 + "total": 0, ~/~/ Общее количество записей 6094 + "pages": 0, ~/~/ Общее количество страниц 6095 + "currentPage": 0, ~/~/ Текущая страница 6096 + "items": [ ~/~/ Записи 6097 + { 6098 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6099 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 6100 + "name": "string", ~/~/ Название задания. 6101 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 6102 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 6103 + "workKind": "string", ~/~/ Вид работ 6104 + "techOp": "string", ~/~/ Тех. операция 6105 + "trailerModel": "string", ~/~/ Модель агрегата 6106 + "width": "string", ~/~/ Ширина, м 6107 + "speed": "string", ~/~/ Тех. скорость 6108 + "fields": "string", ~/~/ Поля 6109 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 6110 + "vehicles": "string", ~/~/ Объект-модель 6111 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 6112 + "drivers": "string", ~/~/ Водители 6113 + "tmc": "string", ~/~/ ТМЦ 6114 + "client": "string", ~/~/ Клиент 6115 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 6116 + "dep": "string", ~/~/ Подразделение 6117 + "geoIds": [ ~/~/ Связанные поля 6118 + 0 6119 + ] 6120 + } 6121 + ] 6122 +} 6123 +))) 6124 + 6125 + 6126 += **Раздел: Роли** = 6127 + 6128 +== **Получение списка клиентских и системных ролей пользователя ** == 6129 + 6130 +(% class="box successmessage" %) 6131 +((( 6132 +**POST /api/v3/groups/find** 6133 +))) 6134 + 6135 +Пример запроса: 6136 + 6137 +((( 6138 +{ 6139 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента содержащий пользовательские роли 6140 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6141 +} 6142 +))) 6143 + 6144 +((( 6145 + 6146 +))) 6147 + 6148 +((( 6149 +Пример ответа: 6150 +))) 6151 + 6152 +((( 6153 +((( 6154 +{ 6155 + "groups": [ ~/~/ Системные роли пользователя 6156 + { 6157 + "code": "string", ~/~/ Код роли. 6158 + "name": "string", ~/~/ Имя 6159 + "shortName": "string" ~/~/ Короткое имя 6160 + } 6161 + ], 6162 + "customGroups": [ ~/~/ Системные роли пользователя 6163 + { 6164 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор роли. 6165 + "name": "string", ~/~/ Наименование 6166 + "shortName": "string", ~/~/ Короткое наименование 6167 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор владельца 6168 + } 6169 + ] 6170 +} 6171 +))) 6172 +))) 6173 + 6174 +((( 6175 + 6176 +))) 6177 + 6178 +((( 6179 + 6180 +))) 6181 + 6182 += **Раздел: Локатор ** = 6183 + 6184 + 6185 +== **Получение списка локаторов, доступных пользователю ** == 6186 + 6187 +(% class="box infomessage" %) 6188 +((( 6189 +**GET /api/v3/locators ** 6190 +))) 6191 + 6192 +В заголовках запроса: X-Auth: Токен авторизации 6193 + 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +((( 6199 +{ 6200 + "vehiclesIds": [ ~/~/ Объекты 6201 + 0 6202 + ], 6203 + "geoIds": [ ~/~/ Геозоны 6204 + 0 6205 + ], 6206 + "fieldsIds": [ ~/~/ Поля 6207 + 0 6208 + ], 6209 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 6210 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 6211 + "agentName": "string", ~/~/ Наименование агента. 6212 + "isEnabled": true, ~/~/ Активность 6213 + "created": "2025-05-26T11:31:05.399Z", ~/~/ Дата создания 6214 + "updated": "2025-05-26T11:31:05.399Z", ~/~/ Дата обновления 6215 + "name": "string", ~/~/ Наименование. 6216 + "status": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 6217 + "activationMode": 0, ~/~/ Определяет вид активации локаторов ( 0 - сейчас, 1 - запланировать на время) 6218 + "activationTime": "2025-05-26T11:31:05.399Z", ~/~/ Время активации 6219 + "validity": 0, ~/~/ Значение срока действия 6220 + "validityType": 0, ~/~/ Тип значения срока действия (Дни = 0, Часы = 1, Минуты = 2) 6221 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6222 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 6223 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 6224 + "url": "string", ~/~/ Ссылка 6225 + "language": 0, ~/~/ Язык 6226 + "showVehicleName": true, ~/~/ Наименование объекта 6227 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6228 + "allowTrackReport": true, ~/~/ Трек 6229 + "showTrackTracing": true, ~/~/ Трассировка трека 6230 + "showSensors": true, ~/~/ Датчик 6231 + "availableMapLayers": [ ~/~/ Слои на карте 6232 + 0 6233 + ] 6234 +} 6235 +))) 6236 +))) 6237 + 6238 + 6239 +== **Получение перечня моделей ** == 6240 + 6241 +(% class="box successmessage" %) 6242 +((( 6243 +**POST /api/v3/models/find** 6244 +))) 6245 + 6246 +Пример запроса: 6247 + 6248 +((( 6249 +((( 6250 +{ 6251 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6252 + "name": "string", ~/~/ Наименование локатора 6253 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор родительского элемента пользователей 6254 +))) 6255 + 6256 + 6257 + 6258 + Пример ответа: 6259 + 6260 + 6261 +((( 6262 +[ 6263 + { 6264 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6265 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя, для которого надо получить данные 6266 + "parentName": "string", ~/~/ Наименование пользователя, для которого надо получить данные 6267 + "name": "string", ~/~/ Наименование локатора 6268 + "modelType": 0 ~/~/ Типы моделей транспортных средств (0 - None, 1 - Агро, 2 - Перевозчик, 3 - Машины) 6269 + } 6270 +] 6271 +))) 6272 +))) 6273 + 6274 + 6275 +== **Создание локатора** == 6276 + 6277 +(% class="box successmessage" %) 6278 +((( 6279 +**POST /api/v3/locators** 6280 +))) 6281 + 6282 +Пример запроса: 6283 + 6284 +((( 6285 +{ 6286 + "isEnabled": true, ~/~/ Активность 6287 + "name": "string", ~/~/ Наименование локатора 6288 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 6289 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 6290 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6291 + "autoProlongation": true, ~/~/ Автопродление срока действия. 6292 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6293 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор клиента. 6294 + "vehiclesIds": [ ~/~/ Oбъекты 6295 + 0 6296 + ], 6297 + "geoIds": [ ~/~/ Геозоны 6298 + 0 6299 + ], 6300 + "fieldsIds": [ ~/~/ Поля 6301 + 0 6302 + ], 6303 + "showVehicleName": true, ~/~/ Наименование объекта 6304 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6305 + "allowTrackReport": true, ~/~/ Трек 6306 + "showTrackTracing": true, ~/~/ Трассировка трека 6307 + "showSensors": true, ~/~/ Датчик 6308 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6309 + ] 6310 +} 6311 +))) 6312 + 6313 + 6314 +Пример ответа: 6315 + 6316 +((( 6317 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 6318 +))) 6319 + 6320 + 6321 + 6322 +== **Изменение локатора** == 6323 + 6324 +(% class="box infomessage" %) 6325 +((( 6326 +**PUT /api/v3/locators** 6327 +))) 6328 + 6329 +Пример запроса: 6330 + 6331 +((( 6332 +{ 6333 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6334 + "isEnabled": true, ~/~/ Активность 6335 + "name": "string", ~/~/ Наименование 6336 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6337 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6338 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6339 + "autoProlongation": true, ~/~/ Автопродление срока действия 6340 + "language": 1 ~/~/ Язык (1- Русский, 2- Английский, 3- Азербайджанский, 4 - Испанский) 6341 + "vehiclesIds": [ ~/~/ Oбъекты 6342 + 0 6343 + ], 6344 + "geoIds": [ ~/~/ Геозоны 6345 + 0 6346 + ], 6347 + "fieldsIds": [ ~/~/ Поля 6348 + 0 6349 + ], 6350 + "showVehicleName": true, ~/~/ Наименование объекта 6351 + "showVehicleDirection": true, ~/~/ Направление движения на треке 6352 + "allowTrackReport": true, ~/~/ Трек 6353 + "showTrackTracing": true, ~/~/ Трассировка трека 6354 + "showSensors": true, ~/~/ Датчик 6355 + "availableMapLayers": 1 [ ~/~/ Слои на карте ,по умолчанию 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ГИС) 6356 + ] 6357 +} 6358 + 6359 + 6360 +))) 6361 + 6362 +Пример ответа: 6363 + 6364 +200 ~/~/ Success 6365 + 6366 + 6367 +== **Удалить локатор** == 6368 + 6369 +(% class="box warningmessage" %) 6370 +((( 6371 +**DELETE /api/v3/locators** 6372 +))) 6373 + 6374 +Пример запроса: 6375 + 6376 +((( 6377 +[ 6378 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6379 +] 6380 +))) 6381 + 6382 + 6383 + 6384 += **Раздел: Яндекс Маршруты** = 6385 + 6386 + 6387 +== **Возвращение списка маршрутов** == 6388 + 6389 +(% class="box infomessage" %) 6390 +((( 6391 +**GET /api/v3/TransportRoutes** 6392 +))) 6393 + 6394 +Пример запроса: 6395 +Id ~/~/ Идентификатор поля 6396 + 6397 + 6398 +Пример ответа: 6399 + 6400 +((( 6401 +[ 6402 + { 6403 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6404 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6405 + "name": "string", ~/~/ Наименование маршрута. 6406 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6407 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6408 + 0 6409 + ] 6410 + } 6411 +] 6412 +))) 6413 + 6414 + 6415 + 6416 +== **Добавить маршрут** == 6417 + 6418 +(% class="box infomessage" %) 6419 +((( 6420 +**POST /api/v3/TransportRoutes** 6421 +))) 6422 + 6423 +Пример запроса: 6424 +{ 6425 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6426 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6427 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6428 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6429 + 0 6430 + ] 6431 +} 6432 + 6433 + 6434 +Пример ответа: 6435 + 6436 +((( 6437 +{ 6438 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6439 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6440 + "name": "string", ~/~/ Определяет наименование маршрута 6441 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6442 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6443 + 0 6444 + ] 6445 +} 6446 +))) 6447 + 6448 + 6449 +== **Обновление маршрута** == 6450 + 6451 +(% class="box successmessage" %) 6452 +((( 6453 +**PUT /api/v3/TransportRoutes** 6454 +))) 6455 + 6456 +Пример запроса: 6457 + 6458 +((( 6459 +{ 6460 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6461 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6462 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6463 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6464 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6465 + 0 6466 + ] 6467 +} 6468 +))) 6469 + 6470 + 6471 +Пример ответа: 6472 + 6473 +((( 6474 +{ 6475 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6476 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6477 + "name": "string", ~/~/ Определяет наименование маршрута 6478 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6479 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6480 + 0 6481 + ] 6482 +} 6483 +))) 6484 + 6485 + 6486 +== **Получить связки маршрутов ТС** == 6487 + 6488 +(% class="box infomessage" %) 6489 +((( 6490 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6491 +))) 6492 + 6493 +Пример запроса: 6494 + 6495 +((( 6496 +[ 6497 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6498 +] 6499 +))) 6500 + 6501 + 6502 +Пример ответа: 6503 + 6504 +((( 6505 +[ 6506 + { 6507 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6508 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6509 + } 6510 +] 6511 +))) 6512 + 6513 + 6514 +== **Удалить маршрут** == 6515 + 6516 +(% class="box warningmessage" %) 6517 +((( 6518 +**DELETE /api/v3/TransportRoutes/{id}** 6519 +))) 6520 + 6521 +Пример запроса: 6522 +Id ~/~/ Идентификатор поля 6523 + 6524 + 6525 + 6526 += **Раздел: Управление доступа к машинам** = 6527 + 6528 + 6529 +== Получение списка транспортных средств видимых пользователю == 6530 + 6531 +(% class="box infomessage" %) 6532 +((( 6533 +**GET /api/v3/UserVisibleVehicles/{userId}** 6534 +))) 6535 + 6536 +Пример ответа: 6537 + 6538 +((( 6539 +{ 6540 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6541 + 0 6542 + ] 6543 +} 6544 +))) 6545 + 6546 + 6547 + 6548 +== Задает видимость транспортных средств пользователю == 6549 + 6550 +(% class="box infomessage" %) 6551 +((( 6552 +**POST /api/v3/UserVisibleVehicles** 6553 +))) 6554 + 6555 +Пример запроса: 6556 + 6557 +((( 6558 +((( 6559 +{ 6560 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6561 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6562 + 0 6563 + ] 6564 +} 6565 +))) 6566 + 6567 +((( 6568 + 6569 +))) 6570 + 6571 +((( 6572 + 6573 +))) 6574 + 6575 +((( 6576 +Пример ответа : 6577 +))) 6578 + 6579 +((( 6580 + 6581 +))) 6582 + 6583 +((( 6584 +200 ~/~/ Success 6585 +))) 6586 +))) 6587 + 6588 + 6589 + 6590 + 6591 + 6592 + 1685 1685 (% class="box" lang="en-US" style="text-align: center;" %) 1686 1686 ((( 1687 1687 (% 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