Changes for page Методы API для работы с ГЛОНАССSoft
Last modified by Андрей Калиновский on 2025/05/06 12:41
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 ... ... @@ -711,7 +711,6 @@ 711 711 "maxspeed": 0, 712 712 "width": 0, 713 713 "imbeddedtrailer": true, 714 - "fueloutlay": 0, 715 715 "hoppercapacity": 0, 716 716 "hopperdischargespeed": 0, 717 717 "modelType": 0, ... ... @@ -728,9 +728,8 @@ 728 728 |(% style="width:215px" %)(% style="color:#000000" %)maxspeed|(% style="width:861px" %)Максимальная технологическая скорость обработки поля, в км/ч 729 729 |(% style="width:215px" %)(% style="color:#000000" %)width|(% style="width:861px" %)Ширина агрегата, в метрах 730 730 |(% style="width:215px" %)(% style="color:#000000" %)imbeddedtrailer|(% style="width:861px" %)Опция: Содержит встроенный агрегат 731 -|(% style="width:215px" %)(% style="color:#000000" %)fueloutlay|(% style="width:861px" %)- 732 732 |(% style="width:215px" %)(% style="color:#000000" %)hoppercapacity|(% style="width:861px" %)Объем бункера 733 -|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость выгрузки из бункера, л/сек 815 +|(% style="width:215px" %)(% style="color:#000000" %)hopperdischargespeed|(% style="width:861px" %)Скорость2 выгрузки из бункера, л/сек 734 734 |(% style="width:215px" %)(% style="color:#000000" %)modelType|(% style="width:861px" %)Определяет тип модели объекта: 0 - None, 1 - Agro, 2 - Cargo, 3 - Car 735 735 |(% style="width:215px" %)(% style="color:#000000" %)id|(% style="width:861px" %)ID модели объекта 736 736 |(% style="width:215px" %)(% style="color:#000000" %)parentId|(% style="width:861px" %)ID клиента, которому принадлежит модель объекта ... ... @@ -822,12 +822,24 @@ 822 822 "maxspeed": 0, 823 823 "width": 0, 824 824 "imbeddedtrailer": true, 825 - "fueloutlay": 0, 826 826 "hoppercapacity": 0, 827 827 "hopperdischargespeed": 0, 828 828 "modelType": 0 829 829 } 830 830 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 831 831 832 832 == (% style="color:#000000; font-size:16px" %)**Редактирование модели**(%%) == 833 833 ... ... @@ -882,6 +882,20 @@ 882 882 "modelType": 0 883 883 } 884 884 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 + 885 885 == (% style="color:#000000; font-size:16px" %)**Удаление модели**(%%) == 886 886 887 887 (% class="box errormessage" %) ... ... @@ -901,7 +901,7 @@ 901 901 902 902 Ответ: В случае успеха **Success 200** 903 903 904 -= (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства**(%%) = 1012 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Транспортные средства (объекты)**(%%) = 905 905 906 906 == (% style="color:#000000; font-size:16px" %)**Получение информации об объекте**(%%) == 907 907 ... ... @@ -930,6 +930,17 @@ 930 930 931 931 ((( 932 932 { 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 + 933 933 "vehicleId": "", ~/~/ ID объекта 934 934 "name": "", ~/~/ Имя объекта 935 935 "imei": "", ~/~/ IMEI объекта ... ... @@ -937,19 +937,15 @@ 937 937 "deviceTypeName": "", ~/~/ Название типа устройства 938 938 "sim1": "", ~/~/ Номер SIM1 939 939 "sim2": "", ~/~/ Номер SIM2 940 - 941 941 "parentId": "", ~/~/ ID клиента-родителя 942 942 "parentName": "", ~/~/ Наименование клиента-родителя 943 943 "modelId": "", ~/~/ ID модели объекта 944 944 "modelName": "", ~/~/ Имя модели объекта 945 - 946 946 "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 947 947 "unitName": "string", ~/~/ Наименование подразделения 948 948 "status": 0, ~/~/ Статус объекта 949 - 950 950 "createdAt": "", ~/~/ Дата создания объекта 951 951 }, 952 - 953 953 "customFields": [ ~/~/ Произвольные поля 954 954 { 955 955 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID поля ... ... @@ -972,8 +972,7 @@ 972 972 "consumptionPerHourSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 973 973 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 974 974 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 975 - "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 976 - 1090 + "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 977 977 "mileageCalcMethod": 0, ~/~/ Метод расчета пробега, 0 - gps, 1 - датчик зажигания 978 978 "mileageCoeff": 0, ~/~/ коэффициент пробега 979 979 "locationByCellId": true, ~/~/ определение местоположения по данным LBS, true - активна, false - не активна ... ... @@ -1003,7 +1003,6 @@ 1003 1003 "retries": 0 ~/~/ Количество попыток 1004 1004 } 1005 1005 ], 1006 - 1007 1007 "sensors": [ ~/~/ Датчики 1008 1008 { 1009 1009 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика ... ... @@ -1030,6 +1030,7 @@ 1030 1030 ], 1031 1031 "showInTooltip": true, ~/~/ Отображать в подсказке 1032 1032 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1146 + "color": "string", ~/~/ Код цвета датчиков 1033 1033 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1034 1034 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1035 1035 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1044,31 +1044,19 @@ 1044 1044 }, 1045 1045 1046 1046 ~/~/ Характерные для произвольного: 1047 - 1048 1048 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1049 - 1050 1050 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1051 - 1052 1052 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1053 - 1054 1054 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1055 - 1056 1056 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1057 - 1058 1058 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1059 - 1060 1060 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1061 - 1062 1062 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1063 - 1064 1064 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1065 - 1066 1066 ~/~/ "ValueOn": "Вкл.", 1067 - 1068 1068 ~/~/ "ValueOff": "Выкл." 1069 1069 "summaryMaxValue": 0 ~/~/ Макс. значение 1070 1070 } 1071 - 1072 1072 "drivers": [ ~/~/ Водители 1073 1073 { 1074 1074 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1077,7 +1077,6 @@ 1077 1077 "isDefault": true ~/~/ По умолчанию 1078 1078 } 1079 1079 ], 1080 - 1081 1081 "inspectionTasks": [ ~/~/ Задания на тех. обслуживание 1082 1082 { 1083 1083 "id": "", ~/~/ ID задания ... ... @@ -1094,19 +1094,27 @@ 1094 1094 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1095 1095 } 1096 1096 ], 1097 - 1098 - "statusHistory": [ ~/~/ История статусов 1198 +"statusHistory": [ ~/~/ История статусов 1099 1099 { 1100 1100 "status": 0, 1101 1101 "date": "2023-05-22T09:57:39.562Z", 1102 1102 "description": "string", 1103 1103 "additionalInfo": "string" 1104 - } 1105 - ] 1106 1106 1205 +((( 1107 1107 } 1207 + ], 1208 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1209 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 1108 1108 ))) 1109 1109 1212 +((( 1213 + ~/~/ 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1214 +} 1215 + 1216 +))) 1217 +))) 1218 + 1110 1110 (% style="text-align:left" %) 1111 1111 Параметр «status» содержит id статуса объекта в системе, соответствие id и текстовое названия статуса приведены ниже: 1112 1112 ... ... @@ -1113,6 +1113,75 @@ 1113 1113 (% style="text-align:left" %) 1114 1114 0 - «Блокировка» 1 - «Активен», 2 - «Отменен», 3 - «Оборудован», 4 - «Диагностика», 5 - «Сервис», 6 - «Демонтаж», 7 - «Монтаж», 8 - «Дозаказ», 9 - «Обслужен», 10 - «Списан», 11 - «Неисправен», 12 - «Проверен», 13 - «Не эксплуатируется». 1115 1115 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 + 1116 1116 == (% style="color:#000000; font-size:16px" %)**Добавление объекта**(%%) == 1117 1117 1118 1118 (% class="box successmessage" %) ... ... @@ -1132,6 +1132,11 @@ 1132 1132 1133 1133 (% style="color:#000000" %){ 1134 1134 1313 + 1314 +((( 1315 + "vehicleId": 0, ~/~/ ID ТС 1316 +))) 1317 + 1135 1135 "parentId": "" , ~/~/ ID клиента 1136 1136 "name": "" , ~/~/ имя ТС 1137 1137 "imei": "" , ~/~/ IMEI ... ... @@ -1152,7 +1152,6 @@ 1152 1152 "consumptionPerHourSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1153 1153 "consumptionIdleSeasonalBegin": "" , ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1154 1154 "consumptionIdleSeasonalEnd": "" , ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1155 - 1156 1156 "mileageCalcMethod": 0, 1157 1157 "mileageCoeff": 0, 1158 1158 "locationByCellId": true, ... ... @@ -1185,7 +1185,6 @@ 1185 1185 "lastInspectionDate": "" , ~/~/ Дата последнего ТО (null - не указано) 1186 1186 "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 1187 1187 } 1188 - 1189 1189 "drivers": [ ~/~/ Водители 1190 1190 { 1191 1191 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ... ... @@ -1200,8 +1200,7 @@ 1200 1200 "retries": 0 1201 1201 } 1202 1202 ], 1203 - 1204 - "sensors": [ ~/~/ Датчики 1384 +"sensors": [ ~/~/ Датчики 1205 1205 { 1206 1206 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1207 1207 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1227,6 +1227,7 @@ 1227 1227 ], 1228 1228 "showInTooltip": true, ~/~/ Отображать в подсказке 1229 1229 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1410 + "color": "string", ~/~/ код цвета датчиков 1230 1230 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1231 1231 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1232 1232 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1239,103 +1239,222 @@ 1239 1239 "additionalProp2": "string", 1240 1240 "additionalProp3": "string" 1241 1241 }, 1242 - 1243 1243 ~/~/ Характерные для произвольного: 1244 - 1245 1245 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1246 - 1247 1247 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1248 - 1249 1249 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1250 - 1251 1251 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1252 - 1253 1253 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1254 - 1255 1255 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1256 - 1257 1257 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1258 - 1259 1259 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1260 - 1261 1261 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1262 - 1263 1263 ~/~/ "ValueOn": "Вкл.", 1264 - 1265 1265 ~/~/ "ValueOff": "Выкл." 1266 - "summaryMaxValue": 0 ~/~/ Макс. значение 1435 + "summaryMaxValue": 0 ~/~/ Определяет максимальное значение датчика в режиме накопления. 1436 + 1437 +((( 1438 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1439 + { 1440 + "from": 0, ~/~/ С какого значения 1441 + "color": "string", ~/~/ Каким цветом 1442 + "text": "string" ~/~/ Текст подписи к этому интервалу 1443 + } 1444 + ] 1267 1267 } 1268 1268 ], 1447 +))) 1448 + 1449 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1450 + 1451 + 1269 1269 "customFields": [ ~/~/ Произвольные поля 1270 1270 { 1271 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1272 - "name": "string", 1273 - "value": "string", 1274 - "forClient": true, 1275 - "forTooltip": true, 1276 - "forReport": true 1277 - } 1278 - ] 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 - По датчику относительных Моточасов 1279 1279 } 1470 +))) 1280 1280 1472 + 1281 1281 (% style="color:#000000" %)Ответ: 1282 1282 1283 -(% style="color:#000000" %){ 1284 1284 1285 - "vehicleId": "", ~/~/ID ТС 1286 - "parentId": "", ~/~/Guid владельца ТС 1287 - "name": "", ~/~/Имя объекта 1288 - "imei": "", ~/~/IMEI 1289 - "deviceTypeId": "", ~/~/ID типа устройства 1290 - "modelId": "", ~/~/ID модели 1291 - "unitId": "", ~/~/ID подразделения 1292 - "sim1": "", ~/~/SIM1 1293 - "sim2": "", ~/~/SIM2 1294 - "consumptionPer100Km": "", ~/~/Расход топлива на 100 км 1295 - "consumptionIdle": "", ~/~/Расход топлива на холостом ходу 1296 - "counters": { ~/~/Счётчики 1297 - "mileageEnabled": true, 1298 - "motohoursEnabled": true, 1299 - "mileage": "", 1300 - "motohours": 345.0 1301 - }, 1302 - "cmsv6Parameters": { ~/~/Параметры CmsV6 1303 - "id": null, 1304 - "enabled": true, ~/~/флаг включения 1305 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1306 - "login": "", ~/~/ имя учетной записи 1307 - "password": "" ~/~/ пароль учетной записи 1308 - }, 1309 - "inspectionTasks": { ~/~/ задания на ТО 1310 - "id": "", ~/~/ ID задачи 1311 - "enabled": false, ~/~/ Признак включения 1312 - "name": "", ~/~/ Имя задания 1313 - "description": "", ~/~/ Описание задания 1314 - "mileageCondition": "", ~/~/ Условие по пробегу 1315 - "lastMileage": "", ~/~/ Пробег (в метрах) 1316 - "motohoursCondition": "", ~/~/ Условие по моточасам 1317 - "lastMotohours": "", ~/~/ Моточасы 1318 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1319 - "kind": "", ~/~/ Вид периодичности по времени 1320 - "maxQuantity": "" ~/~/ Сколько раз выполнить задание (null - однократно) 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 ~/~/ Условие по количеству записей для деактивации 1321 1321 } 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 +))) 1322 1322 1323 -(% style="text-align:left" %) 1324 -(% 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 +))) 1325 1325 1624 + 1326 1326 **Валидация:** 1327 1327 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1328 1328 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; 1329 1329 - при задании сезонной нормы обязательны соответствующие даты начала/окончания. 1330 1330 1331 -== (% style="color:#000000; font-size:16px" %)**Получение параметров объектов**(%%) == 1332 1332 1631 +(% style="color:#000000; font-size:16px" %)**Получение списка объектов с основными параметрами** 1632 + 1333 1333 (% class="box infomessage" %) 1334 1334 ((( 1335 1335 (% lang="en-US" %)**POST /api/v3/vehicles/find** 1336 1336 ))) 1337 1337 1338 -(% style="color:#000000" %)Метод позволяет получить основные параметр ы объектов: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель).1638 +(% style="color:#000000" %)Метод позволяет получить список доступных объектов мониторинга (транспортных средств) с их основными параметрами: наименование, IMEI, тип устройства, модель объекта, подразделение, номера телефонов и идентификатор клиента, к которому прикреплен объект (клиент-родитель). 1339 1339 1340 1340 (% style="color:#000000" %)Метод возвращает информацию об объектах с учетом настроек авторизованного пользователя, указанного в запросе: 1341 1341 ... ... @@ -1369,9 +1369,12 @@ 1369 1369 "imei": null, ~/~/ "710179307", ~/~/ IMEI (string, опционально) 1370 1370 "sim": null, ~/~/ "938112", ~/~/ Номер телефона (string, опционально) 1371 1371 "deviceTypeId": null, ~/~/ 5, ID типа устройства (short, опционально) 1372 - "parentId": null, ~/~/ ID клиента (Guid, опционально) 1373 - "unitId": null, ~/~/ "b33548c3-73c3-40e4-8b78-81470ae744ed", ID подразделения (Guid, опционально) 1374 - "customFields": null ~/~/ значение любого из произвольных полей ТС 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" ~/~/ Идентификатор агента, для которого надо получить данные 1375 1375 } 1376 1376 1377 1377 (% style="color:#000000" %)Фильтрация осуществляется по точному совпадению значений параметров «__**vehicleId**__», «__**deviceTypeId**__», «__**parentId**__», «__**unitId**__», и по частичному - «__**name**__», «__**imei**__», «__**sim**__». Фильтрация по значению параметра «__**sim**__» осуществляется при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. ... ... @@ -1378,8 +1378,14 @@ 1378 1378 1379 1379 (% style="color:#000000" %)Ответ: 1380 1380 1381 -(% style="color:#000000" %){ 1684 +(% style="color:#000000" %)[ 1685 +{ 1382 1382 1687 +((( 1688 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid TC 1689 +))) 1690 + 1691 +((( 1383 1383 (% style="color:#000000" %) "vehicleId": "" ~/~/ идентификатор объекта 1384 1384 "name": "" ~/~/ наименование объекта 1385 1385 "imei": "" ~/~/ IMEI объекта ... ... @@ -1405,9 +1405,21 @@ 1405 1405 "forClient": true, ~/~/ право на отображение у клиента 1406 1406 "forTooltip": false, ~/~/ право на отображение в подсказке 1407 1407 "forReport": false ~/~/ право на отображение в отчетах 1408 - }(%%) 1409 -(% style="color:#000000" %)} 1717 +))) 1410 1410 1719 +((( 1720 + } 1721 + ], 1722 + "vehicleGroups": [ ~/~/ Группы ТС 1723 + { 1724 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1725 + "name": "string" ~/~/ Наименование группы ТС 1726 + } 1727 + ] 1728 + } 1729 +] 1730 +))) 1731 + 1411 1411 (% style="color:#000000" %) Параметры «__**sim1**__» и «__**sim2**__» содержатся в ответе при наличии у авторизованного пользователя права **«__Просмотр номеров телефонов объектов__»**. Параметр «__**status**__» содержится в ответе при наличии у авторизованного пользователя права **«__Просмотр статуса объекта__»**. 1412 1412 1413 1413 == (% style="color:#000000; font-size:16px" %)**Изменение статуса объекта**(%%) == ... ... @@ -1439,13 +1439,11 @@ 1439 1439 "data": "", ~/~/ Данные 1440 1440 "overwrite": false, ~/~/ Флаг перезаписи 1441 1441 "stage": "", ~/~/ Состояние, может быть null 1442 - 1443 1443 (% style="color:#000000" %)} 1444 1444 1445 1445 (% style="color:#000000" %)Ответ: 1446 1446 1447 -(% style="color:#000000" %){ 1448 - 1767 +(% style="color:#000000" %){(%%) 1449 1449 "status": "", ~/~/ значение статуса 1450 1450 "date": "", ~/~/ Дата смены статуса 1451 1451 "description": "", ~/~/ Описание ... ... @@ -1452,10 +1452,10 @@ 1452 1452 "data": "", ~/~/ Данные 1453 1453 "overwrite": false, ~/~/ Флаг перезаписи 1454 1454 "stage": "", ~/~/ Состояние 1455 - 1456 -(% style="text-align:left" %) 1457 1457 (% style="color:#000000" %) } 1458 1458 1776 +== == 1777 + 1459 1459 == (% style="color:#000000; font-size:16px" %)**Редактирование объекта**(%%) == 1460 1460 1461 1461 (% class="box warningmessage" %) ... ... @@ -1531,9 +1531,19 @@ 1531 1531 1532 1532 "drivers": [ ~/~/ Водители 1533 1533 { 1534 - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 1535 - "isDefault": true 1536 - } 1853 + 1854 +((( 1855 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 1856 + "inputNumber": 0, ~/~/ № входа. 1857 + "createTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени создания назначения. 1858 + "comment": "string", ~/~/ Комментарий. 1859 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 1860 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 1861 + "beginTime": "2024-12-23T10:45:04.961Z", ~/~/ Момент времени начала назначения. 1862 + "endTime": "2024-12-23T10:45:04.961Z" ~/~/ Момент времени окончания назначения. 1863 +))) 1864 + 1865 + } 1537 1537 ], 1538 1538 "commandTemplates": [ ~/~/ Шаблон команды 1539 1539 { ... ... @@ -1543,8 +1543,7 @@ 1543 1543 "retries": 0 1544 1544 } 1545 1545 ], 1546 - 1547 - "sensors": [ ~/~/ Датчики 1875 +"sensors": [ ~/~/ Датчики 1548 1548 { 1549 1549 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 1550 1550 "kind": 0, ~/~/ Тип, Simple - простой, Composite - виртуальный ... ... @@ -1570,6 +1570,11 @@ 1570 1570 ], 1571 1571 "showInTooltip": true, ~/~/ Отображать в подсказке 1572 1572 "showLastValid": true, ~/~/ Отображать последнее валидное значение 1901 + 1902 +((( 1903 + "color": "string",** ~/~/ **Цвет датчика 1904 +))) 1905 + 1573 1573 "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 1574 1574 "showWithoutIgn": true, ~/~/ Отображать трек без включенного зажигания 1575 1575 "agrFunction": 0, ~/~/ Функция, SUM, AVG, EXPRESSION ... ... @@ -1582,95 +1582,225 @@ 1582 1582 "additionalProp2": "string", 1583 1583 "additionalProp3": "string" 1584 1584 }, 1585 - 1586 1586 ~/~/ Характерные для произвольного: 1587 - 1588 1588 ~/~/ "EventsEnabled": "off", ~/~/ Фиксировать события работы: on, off 1589 - 1590 1590 ~/~/ "EventsTemplateName": "Работа Произвольный", ~/~/ Наименование события работы 1591 - 1592 1592 ~/~/ "EventsCountEnabled": "off", ~/~/ Фиксировать количество срабатываний: on, off 1593 - 1594 1594 ~/~/ "EventsCountTemplateName": "Количество срабатываний Произвольный", ~/~/Наименование ~/~/события количества срабатываний 1595 - 1596 1596 ~/~/ "MapDisplayEnabled": "off", ~/~/ Отображать на карте: on, off 1597 - 1598 1598 ~/~/ "ChartDisplayEnabled": "off", ~/~/ Отображать на графике объекта: on, off 1599 - 1600 1600 ~/~/ "PayloadChartDisplayEnabled": "off", ~/~/ Отображать на графике полезной нагрузки: on, off 1601 - 1602 1602 ~/~/ "DrawType": ~/~/ тип отрисовки line, bar (Линия, Область) 1603 - 1604 1604 ~/~/ Характерные для таблицы тарировки Вкл./Выкл.: 1605 - 1606 1606 ~/~/ "ValueOn": "Вкл.", 1607 - 1608 1608 ~/~/ "ValueOff": "Выкл." 1609 1609 "summaryMaxValue": 0 ~/~/ Макс. значение 1931 + 1932 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 1933 + { 1934 + "from": 0, ~/~/ С какого значения 1935 + "color": "string", ~/~/ Каким цветом 1936 + "text": "string" ~/~/ Текст подписи к этому интервалу 1937 + } 1938 + ] 1610 1610 } 1611 1611 ], 1941 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 1942 + 1612 1612 "customFields": [ ~/~/ Произвольные поля 1613 - { 1614 - 1615 - "name": "string", 1616 - "value": "string", 1617 - "forClient": true, 1618 - "forTooltip": true, 1619 - "forReport": true 1944 + { 1945 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 1946 + "name": "string", ~/~/ Наименование произвольного поля 1947 + "value": "string", ~/~/ Значение произвольного поля 1948 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 1949 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 1950 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 1620 1620 } 1621 - ] 1952 + 1953 +((( 1954 + ], 1955 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - По датчику зажигания, 1 - По датчику Моточасов, 2 - По датчику относительных Моточасов 1956 +))) 1957 + 1622 1622 } 1623 1623 1960 + 1624 1624 (% style="color:#000000" %)Ответ: 1625 1625 1626 -(% lang="en-US" style="text-align:left" %) 1627 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %){ 1963 +((( 1964 +{ 1965 + "vehicleId": 0, ~/~/ ID ТС 1966 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid владельца ТС 1967 + "name": "string", ~/~/ Имя объекта 1968 + "imei": "string", ~/~/ IMEI 1969 + "deviceTypeId": 0, ~/~/ ID типа устройства 1970 + "modelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID модели 1971 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID подразделения 1972 + "sim1": "string", ~/~/ SIM1 1973 + "sim2": "string", ~/~/ SIM2 1974 + "consumptionPer100Km": 0, ~/~/ Расход топлива на 100 км 1975 + "consumptionPerHour": 0, ~/~/ Расход топлива на моточас 1976 + "consumptionIdle": 0, ~/~/ Расход топлива на холостом ходу 1977 + "consumptionPer100KmSeasonal": 0, ~/~/ Сезонный расход топлива на 100 км 1978 + "consumptionPerHourSeasonal": 0, ~/~/ Сезонный расход топлива на моточас 1979 + "consumptionIdleSeasonal": 0, ~/~/ Сезонный расход топлива на холостом ходу 1980 + "consumptionPer100KmSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на 100 км 1981 + "consumptionPer100KmSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на 100 км 1982 + "consumptionPerHourSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на моточас 1983 + "consumptionPerHourSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на моточас 1984 + "consumptionIdleSeasonalBegin": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц начала работы сезонной нормы расхода на х/х 1985 + "consumptionIdleSeasonalEnd": "2024-10-30T10:31:17.196Z", ~/~/ День/месяц окончания работы сезонной нормы расхода на х/х 1986 + "mileageCalcMethod": 0, ~/~/ Вид расчёта пробега. 0 - ByGps, 1 - ByMileageSensor 1987 + "mileageCoeff": 0, ~/~/ Коэффициент пробега при расчёте пробега по GPS (по умолчанию - 1) 1988 + "locationByCellId": true, ~/~/ Вычислять ли положение по базовым станциям, если координаты по GPS невалидны? 1989 + "dottedLineTrackWhenNoCoords": true, ~/~/ Обозначать пунктиром трек при отсутствии координат. 1990 + "showLineTrackWhenNoCoords": true, ~/~/ Обозначать трек при отсутствии координат. 1991 + "counters": { ~/~/ состояний счётчиков 1992 + "mileageEnabled": true, ~/~/ Флаг включения счётчика "Пробег" 1993 + "motohoursEnabled": true, ~/~/ Флаг включения счётчика "Моточасы" 1994 + "mileage": 0, ~/~/ Пробег 1995 + "motohours": 0 ~/~/ Моточасы 1996 + }, 1997 + "cmsv6Parameters": { ~/~/ Dto для CMSv6 1998 + "id": "string", ~/~/ CMSV6 Идентификатор 1999 + "enabled": true, ~/~/ Признак включения 2000 + "host": "string", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6. 2001 +))) 1628 1628 1629 -(% lang="en-US" style="text-align:left" %) 1630 - "vehicleId": "", ~/~/ ID ТС 1631 - "parentId": "", ~/~/ ID клиента 1632 - "name": "", ~/~/ имя ТС 1633 - "imei": "", ~/~/ IMEI 1634 - "deviceTypeId": "", ~/~/ типа устройства 1635 - "modelId": "", ~/~/ ID модели 1636 - "unitId": "", ~/~/ ID подразделения 1637 - "sim1": "", ~/~/ SIM 1 1638 - "sim2": "", ~/~/ SIM2 1639 - "consumptionPer100Km": "", ~/~/ Расход топлива на 100 км 1640 - "consumptionIdle": "", ~/~/ Расход топлива на холостом ходу 1641 - "counters": 1642 - { 1643 - "mileageEnabled": true, ~/~/ флаг активности счётчика «пробег» 1644 - "motohoursEnabled": true, ~/~/ флаг активности счётчика «моточасы» 1645 - "mileage": "", ~/~/ пробег 1646 - "motohours": "", ~/~/ моточасы 1647 - } 1648 - "cmsv6Parameters": ~/~/ параметры CMSv6 2003 + 2004 +((( 2005 +~/~/ Порт также можно указать. В случае использования безопасного соединения необходимо указать протокол. 2006 + "login": "string", ~/~/ CMSV6 имя учетной записи 2007 + "password": "string" ~/~/ CMSV6 — пароль учетной записи 2008 + }, 2009 + "inspectionTasks": [ ~/~/ Задания на ТО 2010 + { 2011 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID задачи 2012 + "enabled": true, ~/~/ Признак включения 2013 + "name": "string", ~/~/ Имя задания 2014 + "description": "string", ~/~/ Описание задания 2015 + "mileageCondition": 0, ~/~/ Условие по пробегу (в метрах) 2016 + "lastMileage": 0, ~/~/ Пробег (в метрах) на момент последнего ТО 2017 + "motohoursCondition": 0, ~/~/ Условие по моточасам (в секундах) 2018 + "lastMotohours": 0, ~/~/ Моточасы (в секундах) на момент последнего ТО 2019 + "periodicCondition": 0, ~/~/ Условие периодичности по времени 2020 + "kind": 0, ~/~/ Определяет вид периодичности ТО. 0 - Дни, 1 - Месяца, 2 - Годы 2021 + "lastInspectionDate": "2024-10-30T10:31:17.196Z", ~/~/ Дата последнего ТО 2022 + "maxQuantity": 0 ~/~/ Условие по количеству записей для деактивации 2023 + } 2024 + ], 2025 + "drivers": [ ~/~/ Список водителей 2026 + { 2027 + "vehicleId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор объекта. 2028 + "inputNumber": 0, ~/~/ № входа. 2029 + "createTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени создания назначения. 2030 + "comment": "string", ~/~/ Комментарий. 2031 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор назначения. 2032 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя. 2033 + "beginTime": "2024-10-30T10:31:17.196Z", ~/~/ Момент времени начала назначения. 2034 + "endTime": "2024-10-30T10:31:17.196Z" ~/~/ Момент времени окончания назначения. 2035 + } 2036 + ], 2037 + "commandTemplates": [ ~/~/ Список шаблонов команд 2038 + { 2039 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID шаблона 2040 + "name": "string", ~/~/ Название шаблона команд 2041 + "command": "string", ~/~/ Команда на выполнение 2042 + "retries": 0 ~/~/ Лимит попыток отправки 2043 + } 2044 + ], 2045 + "sensors": [ ~/~/ Список датчиков 2046 + { 2047 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID датчика 2048 + "kind": 0, ~/~/ Определяет виды датчиков. 0 - Simple, 1 - Composite 2049 + "type": 0, ~/~/ Определяет типы датчиков. 0 - None, 1 - FuelLvl, 2 - PowerLevel, 3 - Consumption, 4 - Ignition, 2050 +))) 2051 + 2052 +((( 2053 +~/~/ 5 - Crane, 6 - Greider, 8 - Power, 11 - Arrow, 14 - Otval, 15 - Sand, 17 - MixerLand, 18 - MixerMove, 20 - Temperature, 2054 +))) 2055 + 2056 +((( 2057 +~/~/ 21 - Warning, 22 - Metla, 23 - Kosilka, 24 - DriverRFID, 25 - ReFueller, 27 - GrainLvl, 28 - EngineRPM, 29 - BodyUp, 2058 +))) 2059 + 2060 +((( 2061 +~/~/ 31 - EngineTemperature, 32 - TrailerRFID, 33 - Tank, 34 - Unloading, 35 - Custom, 36 - GNSS, 37 - WeighingTerminal, 2062 +))) 2063 + 2064 +((( 2065 +~/~/ 38 - RelativeMotohours, 39 - MileageSensor, 40 - Motohours, 41 - BunkerLowLevel, 42 - BunkerHighLevel, 2066 +))) 2067 + 2068 +((( 2069 +~/~/ 43 - AppliedKg, 44 - TreatedHa, 45 - RateKgHa, 46 - FertilizerLevel, 47 - FactOfWork, 48 - ReapingAggregate, 49 - AverageRateKgHa, 50 - Speed 2070 + "name": "string", ~/~/ Имя датчика 2071 + "inputType": 0, ~/~/ Тип входа, на который подключается определенный тип датчика. 0 - Digital, 1 - Analog, 2 - Impulse, 2072 +))) 2073 + 2074 +((( 2075 +~/~/ 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Diagnosis, 7 - Wire, 8 - ImpulseFrequency, 9 - BLE, 255 - Virtual 2076 + "inputNumber": 0, ~/~/ Номер входа 2077 + "pseudonym": "string", ~/~/ Псевдоним 2078 + "medianDegree": 0, ~/~/ Степень медианной фильтрации 2079 + "isInverted": true, ~/~/ Признак инверсии 2080 + "disabled": true, ~/~/ Датчик не участвует в обработке 2081 + "gradeType": 0, ~/~/ Способ тарировки показаний датчика. 0 - Default, 1 - Digital, 2 - GradeTable, 3 - CounterSummary, 4 - CounterDiffs 2082 + "gradesTables": [ ~/~/ Тарировка 1649 1649 { 1650 - "id": ~/~/ идентификатор 1651 - "enabled": true, ~/~/ флаг включения 1652 - "host": "", ~/~/ IP-адрес или доменное имя из URL веб-сайта CMSV6 1653 - "login": "", ~/~/ имя учетной записи 1654 - "password": "", ~/~/ пароль учетной записи 1655 - } 1656 - "inspectionTasks": ~/~/ задания на ТО 1657 - { 1658 - "id": "", ~/~/ ID задания 1659 - "enabled": false, ~/~/ Признак включения 1660 - "name": "", ~/~/ Имя задания 1661 - "description": "", ~/~/ Описание задания 1662 - "mileageCondition": "", ~/~/ Условие по пробегу 1663 - "lastMileage": "", ~/~/ Пробег (в метрах) на момент последнего ТО 1664 - "motohoursCondition": "", ~/~/ Условие по моточасам 1665 - "lastMotohours": "", ~/~/ Моточасы 1666 - "periodicCondition": "", ~/~/ Условие периодичности по времени 1667 - "kind": "", ~/~/ Вид периодичности по времени 1668 - "maxQuantity": "", ~/~/ Сколько раз выполнить задание 2084 + "grades": [ ~/~/ Таблицы тарировки 2085 + { 2086 + "input": 0, ~/~/ Вход 2087 + "output": 0 ~/~/ Выход 2088 + } 2089 + ], 2090 + "relevanceTime": "2024-10-30T10:31:17.196Z" ~/~/ Время, с которого наступает актуальность таблицы тарировки 1669 1669 } 2092 + ], 2093 + "showInTooltip": true, ~/~/ Отображение в подсказке 2094 + "showLastValid": true, ~/~/ Отображать последнее валидное значение 1670 1670 1671 -(% lang="en-US" style="text-align:left" %) 1672 -(% lang="ru-RU" style="color:#000000; font-weight:normal" %)} 2096 +((( 2097 + "color": "string", ~/~/ цвет уведомлений 2098 +))) 1673 1673 2100 + "showAsDutOnGraph": true, ~/~/ Отображать на графике как датчик уровня топлива 2101 + "showWithoutIgn": true, ~/~/ Отображать без включенного зажигания 2102 + "agrFunction": 0, ~/~/ Агрегирующая функция. 0 - SUM, 1 - AVG, 2 - EXPRESSION 2103 + "expr": "string", ~/~/ Выражение 2104 + "children": [ ~/~/ Cписок добавленных в агрегацию физ. датчиков 2105 + "string" 2106 + ], 2107 + "customParams": { ~/~/ Дополнительные настройки 2108 + "additionalProp1": "string", 2109 + "additionalProp2": "string", 2110 + "additionalProp3": "string" 2111 + }, 2112 + "summaryMaxValue": 0, ~/~/ Определяет максимальное значение датчика в режиме накопления. 2113 + "valueIntervals": [ ~/~/ Интервалы значений для подсветки в мониторинге 2114 + { 2115 + "from": 0, ~/~/ С какого значения 2116 + "color": "string", ~/~/ Каким цветом 2117 + "text": "string" ~/~/ Текст подписи к этому интервалу 2118 + } 2119 + ] 2120 + } 2121 + ], 2122 + "highlightSensorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid датчика, выбранного для подсветки его значения в различных интервалах 2123 + "customFields": [ ~/~/ Список произвольных полей 2124 + { 2125 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ System.Guid идентификатор элемента сущности 2126 + "name": "string", ~/~/ Наименование произвольного поля 2127 + "value": "string", ~/~/ Значение произвольного поля 2128 + "forClient": true, ~/~/ Отобразить произвольное поле у клиента 2129 + "forTooltip": true, ~/~/ Отобразить произвольное поле в подсказке (при наведении на ТС на карте) 2130 + "forReport": true ~/~/ Отобразить произвольное поле в отчете 2131 + } 2132 + ], 2133 + "motohoursCalcMethod": 0 ~/~/ Вид расчета моточасов. 0 - ByIgnitionSensor, 1 - ByMotohoursSensor, 2 - ByRelativeMotohoursSensor 2134 +} 2135 +))) 2136 + 1674 1674 **Валидация:** 1675 1675 - сезонный параметр может быть задан только если задана соответствующая обычная норма; 1676 1676 - сезонные начало и окончание могут быть заданы только если задана соответствующая сезонная норма; ... ... @@ -1709,18 +1709,15 @@ 1709 1709 1710 1710 (% style="color:#000000" %)Метод запроса: **GET** 1711 1711 1712 -(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/ users/api/v3/devices/types>>url:https://hosting.glonasssoft.ru/api/v3/users/api/v3/devices/types]]2175 +(% style="color:#000000" %)URL запроса: (%%)[[https:~~/~~/hosting.glonasssoft.ru/api/v3/devices/types>>https://hosting.glonasssoft.ru/api/v3/devices/types]] 1713 1713 1714 1714 (% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1715 1715 1716 1716 (% style="color:#000000" %)Ответ: 1717 1717 1718 -(% style="color:#000000" %){ 1719 - 2181 +(% style="color:#000000" %){(%%) 1720 1720 "deviceTypeId" : "", ~/~/ ID типа устройства 1721 1721 "deviceTypeName" : "" ~/~/ Название типа устройства 1722 - 1723 -(% style="text-align:left" %) 1724 1724 (% style="color:#000000" %)} 1725 1725 1726 1726 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Датчики**(%%) = ... ... @@ -1742,13 +1742,10 @@ 1742 1742 1743 1743 (% style="color:#000000" %)Ответ: 1744 1744 1745 -(% style="color:#000000" %){ 1746 - 2205 +(% style="color:#000000" %){(%%) 1747 1747 "id": "", ~/~/ ID типа датчика 1748 1748 "name": "", ~/~/ Название 1749 1749 "description": "", ~/~/ Описание 1750 - 1751 -(% style="text-align:left" %) 1752 1752 (% style="color:#000000" %)} 1753 1753 1754 1754 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Сообщения**(%%) = ... ... @@ -1792,6 +1792,56 @@ 1792 1792 } 1793 1793 ] 1794 1794 2252 +== (% style="color:#000000; font-size:16px" %)**Получить тип и номер входа сырого параметра **(%%) == 2253 + 2254 +(% class="box infomessage" style="text-align: left;" %) 2255 +((( 2256 +**POST /api/v3/terminalMessages/mapping** 2257 +))) 2258 + 2259 +Запрос позволяет узнать тип и номер входа для сырого параметра, приходящего по указанному протоколу. 2260 + 2261 +(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/terminalMessages/mapping 2262 + 2263 +(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 2264 + 2265 +{ 2266 + "protocolType": 0, 2267 + "params": ["string"] 2268 +} 2269 + 2270 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2271 +|protocolType|ID типа протокола 2272 +|params|((( 2273 +Массив наименований параметров в сообщении 2274 +))) 2275 + 2276 +Ответ: 2277 + 2278 +{ 2279 + "protocolType": 0, 2280 + "mapping": { 2281 + "additionalProp1": { 2282 + "inputType": 0, 2283 + "inputNumber": 0 2284 + }, 2285 + "additionalProp2": { 2286 + "inputType": 0, 2287 + "inputNumber": 0 2288 + } 2289 + } 2290 +} 2291 + 2292 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2293 +|protocolType|Тип протокола 2294 +|inputType|Тип входа, 0 - Цифровой, 1 - Аналоговый, 2 - Импульсный, 3 - Rs232, 4 - Rs485, 5 - FMS, 6 - Диагностический, 7 - 1-Wire, 8 - Частотный, 9 - BLE, 255 - Виртуальный 2295 +|inputNumber|((( 2296 +Номер входа 2297 +))) 2298 + 2299 +(% class="wikigeneratedid" %) 2300 +Перечень 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/]] 2301 + 1795 1795 == (% style="color:#000000; font-size:16px" %)**Запрос списка сообщений**(%%) == 1796 1796 1797 1797 (% class="box infomessage" %) ... ... @@ -1816,6 +1816,11 @@ 1816 1816 "to": "2023-03-29T09:14:46.107Z" ~/~/ конец периода запроса 1817 1817 } 1818 1818 2326 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2327 +|vehicleId|ID объекта 2328 +|from|Дата и время начала периода запроса 2329 +|to|Дата и время окончания периода запроса 2330 + 1819 1819 Ответ: 1820 1820 1821 1821 [ ... ... @@ -1822,80 +1822,43 @@ 1822 1822 { 1823 1823 "messages": [ 1824 1824 { 1825 - "deviceTime": "2023-03-29T09:14:46.125Z", ~/~/ Время устройства 1826 - "serverTime": "2023-03-29T09:14:46.125Z", ~/~/ Время сервера 1827 - "speed": 0, ~/~/ Скорость, км/ч 1828 - "altitude": 0, ~/~/ Высота, м 1829 - "latitude": 0, ~/~/ Широта [-90°;90°] 1830 - "longitude": 0, ~/~/ Долгота [-180°;180°] 1831 - "satellites": 0, ~/~/ Кол-во спутников 1832 - "voltage": 0, ~/~/ Напряжение 1833 - "parameters": { ~/~/ список параметров датчиков передаваемых терминалом 2337 + "deviceTime": "2023-11-29T07:40:44.052Z", 2338 + "serverTime": "2023-11-29T07:40:44.052Z", 2339 + "speed": 0, 2340 + "altitude": 0, 2341 + "latitude": 0, 2342 + "longitude": 0, 2343 + "satellites": 0, 2344 + "course": 0, 2345 + "voltage": 0, 2346 + "parameters": { 1834 1834 "additionalProp1": "string", 1835 1835 "additionalProp2": "string", 1836 1836 "additionalProp3": "string" 1837 1837 }, 1838 - "photoCount": 0 ~/~/ Кол-во фото 2351 + "photoCount": 0, 2352 + "lbsCorrectedCoords": true, 2353 + "protocolType": 0 1839 1839 } 1840 1840 ] 1841 1841 } 1842 1842 ] 1843 1843 1844 -== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 2359 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 2360 +|deviceTime|Время сообщения терминала 2361 +|serverTime|Время когда сообщение поступило на сервер 2362 +|speed|Скорость 2363 +|altitude|Высота над уровнем моря 2364 +|latitude|Широта 2365 +|longitude|Долгота 2366 +|satellites|Кол-во спутников 2367 +|course|Курс 2368 +|voltage|Бортовое напряжение 2369 +|parameters|Список параметров и их значений 2370 +|photoCount|Количество фото 2371 +|lbsCorrectedCoords|Признак того, что координаты были скорректированы по LBS, true - скорректированы, false - не скорректированы 2372 +|protocolType|ID типа протокола 1845 1845 1846 -(% class="box infomessage" %) 1847 -((( 1848 -**POST /api/v3/vehicles/export/history** 1849 -))) 1850 - 1851 -Метод возвращает список сообщений терминала объекта за выбранный период. 1852 - 1853 -(% style="text-align: left;" %) 1854 -Метод запроса **POST** 1855 - 1856 -(% style="text-align: left;" %) 1857 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/export/history 1858 - 1859 -(% style="text-align: left;" %) 1860 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1861 - 1862 -{ 1863 - "vehicleId": 0, ~/~/ ID объекта 1864 - "asArchive": true, ~/~/ true - Архивировать файл, False - не архивировать 1865 - "from": "2023-09-27T12:17:45.973Z", ~/~/ Дата и время начала запроса 1866 - "to": "2023-09-27T12:17:45.973Z" ~/~/ Дата и время окончания запроса 1867 -} 1868 - 1869 -Ответ: 1870 - 1871 -Получаете файл. Сообщение: Code 200/Success 1872 - 1873 -== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 1874 - 1875 -(% class="box infomessage" %) 1876 -((( 1877 -**GET /api/v3/vehicles/export/history/status** 1878 -))) 1879 - 1880 -Метод возвращает список сообщений терминала объекта за выбранный период. 1881 - 1882 -(% style="text-align: left;" %) 1883 -Метод запроса **GET** 1884 - 1885 -(% style="text-align: left;" %) 1886 -(% style="color:#000000" %)URL запроса: (%%)https:~/~/hosting.glonasssoft.ru/api/v3/export/history/status 1887 - 1888 -(% style="text-align: left;" %) 1889 -(% style="color:#000000" %)В заголовках запроса: X-Auth: Токен авторизации 1890 - 1891 -Ответ: 1892 - 1893 -{ 1894 - "activity": true, ~/~/ статус экспорт, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 1895 - "progress": 0, ~/~/ прогресс экспорта, от 0 до 100%. 1896 - "message": "string" ~/~/ текст описывающий статус. 1897 -} 1898 - 1899 1899 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос данных об объекте за период**(%%) = 1900 1900 1901 1901 == (% style="color:#000000; font-size:16px" %)**Получение данных о пробеге и моточасах транспортного средства**(%%) == ... ... @@ -1932,10 +1932,14 @@ 1932 1932 { 1933 1933 "start": "2023-08-09T14:23:14.574Z", ~/~/ Начало 1934 1934 "end": "2023-08-09T14:23:14.574Z", ~/~/ Окончание 1935 - "mileageBegin": 0, ~/~/ Пробег на начало периода 1936 - "mileageEnd": 0, ~/~/ Пробег на окончание периода 1937 - "motohoursBegin": 0, ~/~/ Моточасы на начало периода 1938 - "motohoursEnd": 0 ~/~/ Моточасы на окончание периода 2410 + "mileage": 0, ~/~/ Пробег за период, километры 2411 + "mileageBegin": 0, ~/~/ Пробег на начало периода, километры 2412 + "mileageEnd": 0, ~/~/ Пробег на окончание периода, километры 2413 + "motohours": 0, ~/~/ Моточасы за период, секунды 2414 + "motohoursBegin": 0, ~/~/ Моточасы на начало периода, секунды 2415 + "motohoursEnd": 0 ~/~/ Моточасы на окончание периода, секунды 2416 + "idlingTime": 0 ~/~/ Холостой ход за период, секунд 2417 + 1939 1939 } 1940 1940 ] 1941 1941 } ... ... @@ -1979,11 +1979,19 @@ 1979 1979 "fuelLevelEnd": 0, ~/~/ Уровень топлива на конец периода 1980 1980 "fuelConsumption": 0, ~/~/ Расход топлива 1981 1981 "fuelConsumptionMove": 0 ~/~/ Расход топлива в движении 2461 + "fuelConsumptionFactTank": 0 ~/~/ Фактический расход топлива в цистерне 2462 + 1982 1982 } 1983 1983 ] 1984 1984 } 1985 1985 ] 1986 1986 2468 +(% class="box warningmessage" %) 2469 +((( 2470 +Максимальное допустимое количество периодов в ответе - 1440. При превышении этого значения будет получена ошибка ""ApiCode":204,"ApiMessage":"Прислана неправильная модель","Message":"Задан слишком маленький период дискретизации"". 2471 +\\При большом количестве периодов существенно растет нагрузка, синхронный запрос может выдать ошибку по таймауту. Рекомендуем не занижать необходимое значение параметра "sampling". 2472 +))) 2473 + 1987 1987 == (% style="color:#000000; font-size:16px" %)**Получение данных о заправках и сливах транспортного средства**(%%) == 1988 1988 1989 1989 (% class="box infomessage" %) ... ... @@ -2018,7 +2018,8 @@ 2018 2018 "model": "string", ~/~/ Модель объекта 2019 2019 "fuels": [ ~/~/ Массив данным по заправкам и сливам 2020 2020 { 2021 - "event": 0, ~/~/ Тип события 20 - TankFuelIn - заправка, 21 - TankFuelOut - слив 2508 + "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 2509 + 2022 2022 "startDate": "2023-08-09T14:27:44.773Z", ~/~/ Начало 2023 2023 "endDate": "2023-08-09T14:27:44.773Z", ~/~/ Окончание 2024 2024 "valueFuel": 0, ~/~/ Количество ... ... @@ -2029,6 +2029,96 @@ 2029 2029 } 2030 2030 ] 2031 2031 2520 + 2521 +== (% style="color:#000000; font-size:16px" %)**Получение данных по событиям движения и стоянок у объектов**(%%) == 2522 + 2523 +(% class="box infomessage" %) 2524 +((( 2525 +**POST /api/v3/vehicles/moveStop** 2526 +))) 2527 + 2528 +Метод запроса: **POST** 2529 + 2530 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/moveStop 2531 + 2532 +В заголовках запроса: X-Auth: Токен авторизации 2533 + 2534 + 2535 +Тело запроса: 2536 + 2537 +{ 2538 + "vehicleIds": [ ], ~/~/ Список ID объектов 2539 + "from": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время начало запроса 2540 + "to": "2024-01-30T10:12:19.125Z", ~/~/ Дата и время окончания запроса 2541 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 2542 +} 2543 + 2544 +Ответ: 2545 + 2546 +[ 2547 + { 2548 + "vehicleId": 0, ~/~/ ID объекта 2549 + "vehicleName": "string", ~/~/ Имя объекта 2550 + "moves": [ ~/~/ Событие движения 2551 + { 2552 + "mileage": 0, ~/~/ Пробег, км 2553 + "eventId": 0, ~/~/ Идентификатор события 2554 + "eventName": "string", ~/~/ Название события 2555 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2556 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2557 + "duration": 0 ~/~/ Продолжительность события, секунд 2558 + } 2559 + ], 2560 + "stops": [ ~/~/ События стоянок 2561 + { 2562 + "address": "[Street] [House] [City] [State] [Country] [Coordinates]", ~/~/ Адрес события Улица, Дом, Город, Регион, Страна, Координаты 2563 + "eventId": 0, ~/~/ Идентификатор события 2564 + "eventName": "string", ~/~/ Название события 2565 + "start": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время начало события 2566 + "end": "2024-01-30T10:17:13.789Z", ~/~/ Дата и время окончания события 2567 + "duration": 0 ~/~/ Продолжительность события, секунд 2568 + } 2569 + ] 2570 + } 2571 +] 2572 + 2573 + 2574 +== (% style="color:#000000; font-size:16px" %)**Получение последних данных объекта**(%%) == 2575 + 2576 +(% class="box infomessage" %) 2577 +((( 2578 +**POST /api/v3/vehicles/getlastdata** 2579 +))) 2580 + 2581 +Метод запроса: **POST** 2582 + 2583 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/vehicles/getlastdata 2584 + 2585 +В заголовках запроса: X-Auth: Токен авторизации 2586 + 2587 + 2588 +В теле запроса перечисляете массив id объектов, в квадратных скобках через запятую. 2589 + 2590 +Ответ: 2591 + { 2592 + "vehicleId": 0, ~/~/Идентификатор объекта. 2593 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",~/~/Идентификатор объекта. 2594 + "vehicleNumber": "string",~/~/Номер объекта. 2595 + "receiveTime": "2024-02-27T14:11:00.315Z",~/~/Время получения записи на сервере, т.е. время срабатывания + время передачи от устройства на сервер 2596 + "recordTime": "2024-02-27T14:11:00.315Z",~/~/Время записи от устройства, т.е. время фактического события на транспортном средстве. 2597 + "state": 0,~/~/Определяет состояния объекта в мониторинге: нет данных - 0; отключена - 1; остановка - 2; стоянка - 3; в движении - 4. 2598 + "speed": 0,~/~/Скорость объекта. 2599 + "course": 0,~/~/Курс движения [0;360] 2600 + "latitude": 0,~/~/Широта [-90°;90°]. 2601 + "longitude": 0,~/~/Долгота [-180°;180°]. 2602 + "address": "string",~/~/Адрес. 2603 + "geozones": [ ~/~/Сведения по геозонам. 2604 + { 2605 + "id": 0, 2606 + "name": "string" 2607 + } 2608 + 2609 + 2032 2032 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Запрос посещений геообъектов**(%%) = 2033 2033 2034 2034 == (% style="color:#000000; font-size:16px" %)**Получение списка всех геообъектов**(%%) == ... ... @@ -2157,6 +2157,35 @@ 2157 2157 } 2158 2158 ] 2159 2159 2738 + 2739 +== (% style="color:#000000; font-size:16px" %)**Обновить информацию по геозоне**(%%) == 2740 + 2741 +(% class="box successmessage" %) 2742 +((( 2743 +(% style="color:#000000; line-height:100%" %)** **(% lang="en-US" %)**PUT **(%%)**/api/v3/gis** 2744 +))) 2745 + 2746 +(% style="color:#000000" %)Метод запроса: **PUT** 2747 + 2748 +Пример запроса: 2749 + 2750 +((( 2751 +{ 2752 + "id": 0, ~/~/ Идентификатор объекта геозоны 2753 + "name": "string", ~/~/ Наименование объекта геозоны 2754 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 2755 + "description": "string", ~/~/ Описание объекта геозоны 2756 + "beginCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата начала расчетов для геозоны 2757 + "endCalc": "2025-04-24T12:10:28.751Z", ~/~/ Дата окончания расчетов для геозоны 2758 + "settingsData": "string" ~/~/ Параметры отображения в формате XML. 2759 +} 2760 +))) 2761 + 2762 + 2763 +Пример ответа: 2764 + 2765 +200 ~/~/ Success 2766 + 2160 2160 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Уведомления**(%%) = 2161 2161 2162 2162 == (% style="color:#000000; font-size:16px" %)**Запрос списка уведомлений клиента**(%%) == ... ... @@ -2336,6 +2336,32 @@ 2336 2336 2337 2337 Success 2338 2338 2946 + 2947 +== (% style="color:#000000; font-size:16px" %)**Автоматическое продление уведомлений **(%%) == 2948 + 2949 +(% class="box warningmessage" %) 2950 +((( 2951 +**PUT** /api/v3/notifications/prolongation 2952 +))) 2953 + 2954 +Метод позволяет продлить уведомления. 2955 + 2956 +Метод запроса **PUT** 2957 + 2958 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/notifications/prolongation 2959 + 2960 +В заголовках запроса: X-Auth: Токен авторизации. 2961 + 2962 +Тело запроса: 2963 + 2964 +[ 2965 + 2966 +0 2967 + 2968 +] 2969 + 2970 +где 0 идентификатор ids. 2971 + 2339 2339 == (% style="color:#000000; font-size:16px" %)**Удаление уведомления**(%%) == 2340 2340 2341 2341 (% class="box errormessage" %) ... ... @@ -2927,6 +2927,83 @@ 2927 2927 Success 2928 2928 2929 2929 3563 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Назначения агрегатов**(%%) = 3564 + 3565 +== (% style="color:#000000; font-size:16px" %)**Получить список назначений агрегатов на выбранные объекты**(%%) == 3566 + 3567 +(% class="box infomessage" %) 3568 +((( 3569 +**POST /api/v3/Trailers** 3570 +))) 3571 + 3572 +Пример запроса: 3573 + 3574 +{ 3575 + "startDate": "2023-11-14T10:48:03.671Z", 3576 + "endDate": "2023-11-14T10:48:03.671Z", 3577 + "ids": [ 0 ], 3578 + "timezone": 0 3579 +} 3580 + 3581 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3582 +|(% style="width:215px" %)startDate|(% style="width:861px" %)Дата и время начала запроса 3583 +|(% style="width:215px" %)endDate|(% style="width:861px" %)Дата и время окончания запроса 3584 +|(% style="width:215px" %)ids|(% style="width:861px" %)Массив ID объектов 3585 +|(% style="width:215px" %)timezone|(% style="width:861px" %)Часовой пояс, по умолчанию UTC. 3586 + 3587 +Пример ответа: 3588 + 3589 +[ 3590 + { 3591 + "SD": "2023-11-14T10:48:03.717Z", 3592 + "ED": "2023-11-14T10:48:03.717Z", 3593 + "id": 0, 3594 + "SLat": 0, 3595 + "SLon": 0, 3596 + "ELat": 0, 3597 + "ELon": 0, 3598 + "mileage": 0 3599 + "Duration": 0 3600 + "Address": "string", 3601 + "Address2": "string", 3602 + "name": "string", 3603 + "rid": "string", 3604 + "rguid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3605 + "trailer": { 3606 + "ModelGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3607 + "Number": "string", 3608 + "Description": "string", 3609 + "OwnerGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3610 + "ExternalID": "string", 3611 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3612 + "CreateTime": "2023-11-14T10:48:03.717Z", 3613 + "UpdateTime": "2023-11-14T10:48:03.717Z", 3614 + "IsDeleted": true 3615 + }, 3616 + "filesCount": 0, 3617 + } 3618 +] 3619 + 3620 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3621 +|SD|Дата и время начала события 3622 +|ED|Дата и время окончания события 3623 +|id|ID объекта 3624 +|SLat|Широта начальной координаты 3625 +|SLon|Долгота начальной координаты 3626 +|ELat|Широта конечной координаты 3627 +|ELon|Долгота конечной координаты 3628 +|mileage|Пробег 3629 +|Duration|Продолжительность 3630 +|Address|Адрес начального местоположения 3631 +|Address2|Адрес конечного местоположения 3632 +|name|Имя радиометки 3633 +|rid|Номер радиометки 3634 +|rguid|ID радиометки 3635 +|trailer|Информация об агрегате 3636 +|ModelGuid|ID агрегата 3637 +|Number|Название/номер агрегата 3638 +|Description|Текст примечания агрегата 3639 + 2930 2930 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Карты-метки**(%%) = 2931 2931 2932 2932 == (% style="color:#000000; font-size:16px" %)**Получить список карт-меток определенного клиента**(%%) == ... ... @@ -2948,13 +2948,19 @@ 2948 2948 { 2949 2949 "name": "string", 2950 2950 "number": 0, 2951 - "period": 0, ~/~/ Частота трансляции радиометки3661 + "period": 0, 2952 2952 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2953 2953 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2954 - "deleted": true 2955 2955 } 2956 2956 ] 2957 2957 3667 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3668 +|parentId|ID клиента 3669 +|name|Название карты-метки 3670 +|number|Номер 3671 +|period|Период запросов в секундах (работает только для агрегатов) 3672 +|id|ID карты-метки 3673 + 2958 2958 == (% style="color:#000000; font-size:16px" %)**Получить данные карты-метки**(%%) == 2959 2959 2960 2960 (% class="box infomessage" %) ... ... @@ -2970,13 +2970,18 @@ 2970 2970 { 2971 2971 "name": "string", 2972 2972 "number": 0, 2973 - "period": 0, ~/~/ Частота трансляции радиометки3689 + "period": 0, 2974 2974 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2975 2975 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2976 - "deleted": true 2977 2977 } 2978 2978 ] 2979 2979 3695 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3696 +|name|Название карты-метки 3697 +|number|Номер 3698 +|period|Период запросов в секундах (работает только для агрегатов) 3699 +|id|ID карты-метки 3700 +|parentId|ID клиента 2980 2980 2981 2981 == (% style="color:#000000; font-size:16px" %)**Добавить карту-метку**(%%) == 2982 2982 ... ... @@ -2992,7 +2992,6 @@ 2992 2992 "number": 0, 2993 2993 "period": 0, 2994 2994 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 2995 - "deleted": true 2996 2996 } 2997 2997 2998 2998 Ответ: ... ... @@ -3003,9 +3003,15 @@ 3003 3003 "period": 0, 3004 3004 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3005 3005 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3006 - "deleted": true 3007 3007 } 3008 3008 3728 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3729 +|name|Название карты-метки 3730 +|number|Номер 3731 +|period|Период запросов в секундах (работает только для агрегатов) 3732 +|id|ID карты-метки 3733 +|parentId|ID клиента 3734 + 3009 3009 == (% style="color:#000000; font-size:16px" %)**Редактировать карту-метку**(%%) == 3010 3010 3011 3011 (% class="box warningmessage" %) ... ... @@ -3021,7 +3021,6 @@ 3021 3021 "period": 0, 3022 3022 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3023 3023 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3024 - "deleted": true 3025 3025 } 3026 3026 3027 3027 Ответ: ... ... @@ -3032,9 +3032,15 @@ 3032 3032 "period": 0, 3033 3033 "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3034 3034 "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 3035 - "deleted": true 3036 3036 } 3037 3037 3762 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3763 +|name|Название карты-метки 3764 +|number|Номер 3765 +|period|Период запросов в секундах (работает только для агрегатов) 3766 +|id|ID карты-метки 3767 +|parentId|ID клиента 3768 + 3038 3038 == (% style="color:#000000; font-size:16px" %)**Удалить карту-метку**(%%) == 3039 3039 3040 3040 (% class="box errormessage" %) ... ... @@ -3042,7 +3042,7 @@ 3042 3042 **DELETE /api/v3/Rfids/{rfidGuid}** 3043 3043 ))) 3044 3044 3045 -Передаем параметр rfidGuid - идентификатор карты-метки 3776 +Передаем параметр **rfidGuid** - идентификатор карты-метки 3046 3046 3047 3047 Ответ: 3048 3048 ... ... @@ -3051,7 +3051,6 @@ 3051 3051 3052 3052 = (% style="color:#000000; font-size:18.6667px" %)Раздел: **Биллинг**(%%) = 3053 3053 3054 -(% class="wikigeneratedid" %) 3055 3055 == (% style="color:#000000; font-size:16px" %)**Узнать баланс клиента**(%%) == 3056 3056 3057 3057 (% class="box infomessage" %) ... ... @@ -3072,7 +3072,6 @@ 3072 3072 |(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 3073 3073 |(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 3074 3074 3075 -(% class="wikigeneratedid" %) 3076 3076 == (% style="color:#000000; font-size:16px" %)**Узнать ограничения клиента**(%%) == 3077 3077 3078 3078 (% class="box infomessage" %) ... ... @@ -3103,7 +3103,6 @@ 3103 3103 |(% style="width:215px" %)SendEmailNotifications|(% style="width:861px" %)Оповещение на почту, true - включено, false - выключено 3104 3104 |(% style="width:215px" %)IsPrivate|(% style="width:861px" %)Признак, определяющий, являются ли параметры ограничений частными т.е. персональными для клиента, либо определяются тарифным планом 3105 3105 3106 -(% class="wikigeneratedid" %) 3107 3107 == (% style="color:#000000; font-size:16px" %)**Узнать состояние тарифного плана клиента**(%%) == 3108 3108 3109 3109 (% class="box infomessage" %) ... ... @@ -3177,7 +3177,6 @@ 3177 3177 |PeriodValue|Значение периода. 3178 3178 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3179 3179 3180 -(% class="wikigeneratedid" %) 3181 3181 == (% style="color:#000000; font-size:16px" %)**Получить тарифные планы принадлежащие клиенту**(%%) == 3182 3182 3183 3183 (% class="box infomessage" %) ... ... @@ -3229,7 +3229,6 @@ 3229 3229 |PeriodValue|Значение периода. 3230 3230 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3231 3231 3232 -(% class="wikigeneratedid" %) 3233 3233 == (% style="color:#000000; font-size:16px" %)**Получить список доступных тарифных планов**(%%) == 3234 3234 3235 3235 (% class="box infomessage" %) ... ... @@ -3281,6 +3281,72 @@ 3281 3281 |PeriodValue|Значение периода. 3282 3282 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3283 3283 4010 +== (% style="color:#000000; font-size:16px" %)**Изменить баланс**(%%) == 4011 + 4012 +(% class="box warningmessage" %) 4013 +((( 4014 +**PUT /api/v3/Billing/client/balance** 4015 +))) 4016 + 4017 +Устанавливает указанное значение баланса не создавая операции пополнение/снятие. 4018 + 4019 +Тело запроса: 4020 + 4021 +{ 4022 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4023 + "Balance": 0 4024 +} 4025 + 4026 +Ответ: Success 4027 + 4028 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4029 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4030 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4031 + 4032 +== (% style="color:#000000; font-size:16px" %)**Пополнить баланс**(%%) == 4033 + 4034 +(% class="box warningmessage" %) 4035 +((( 4036 +**PUT /api/v3/billing/client/balance/deposit** 4037 +))) 4038 + 4039 +Создает операцию **Пополнение **с указанной суммой 4040 + 4041 +Тело запроса: 4042 + 4043 +{ 4044 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4045 + "Balance": 0 4046 +} 4047 + 4048 +Ответ: Success 4049 + 4050 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4051 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4052 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4053 + 4054 +== (% style="color:#000000; font-size:16px" %)**Списать с баланса**(%%) == 4055 + 4056 +Создает операцию **Списание **с указанной суммой 4057 + 4058 +(% class="box warningmessage" %) 4059 +((( 4060 +**PUT /api/v3/billing/client/balance/withdraw** 4061 +))) 4062 + 4063 +Тело запроса: 4064 + 4065 +{ 4066 + "ClientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4067 + "Balance": 0 4068 +} 4069 + 4070 +Ответ: Success 4071 + 4072 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4073 +|(% style="width:215px" %)ClientId|(% style="width:861px" %)Идентификатор клиента 4074 +|(% style="width:215px" %)Balance|(% style="width:861px" %)Значение баланса 4075 + 3284 3284 == (% style="color:#000000; font-size:16px" %)**Изменить ограничения клиента**(%%) == 3285 3285 3286 3286 (% class="box warningmessage" %) ... ... @@ -3343,6 +3343,7 @@ 3343 3343 3344 3344 |=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 3345 3345 |ClientId|Идентификатор клиента 4138 +|PlanId|Идентификатор тарифного плана 3346 3346 |Feature|Код услуги 3347 3347 |IsEnabled|Признак, определяющий активирована ли услуга 3348 3348 |IsFactual|Признак, определяющий расчёт по факту ... ... @@ -3352,7 +3352,2110 @@ 3352 3352 |PeriodValue|Значение периода. 3353 3353 |PeriodType|Определяет тип периода действия услуги в тарифном плане, 0 - Дни, 1 - Месяцы 3354 3354 4148 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Импорт и Экспорт**(%%) = 3355 3355 4150 +(% class="box warningmessage" %) 4151 +((( 4152 +Для тестирования запросов **Импорта **в Postman необходимо скачать его на ПК. Версия в браузере не позволяет загружать файлы в тело запроса. 4153 +))) 4154 + 4155 +== (% style="color:#000000; font-size:16px" %)**Импорт объектов**(%%) == 4156 + 4157 +(% class="box infomessage" %) 4158 +((( 4159 +**POST /api/v3/vehicles/import/{agentId}** 4160 +))) 4161 + 4162 +Запрос позволяет загрузить объекты в систему из файла. Импортируемый файл может быть в формате **xml (расширение *.xls)** или **wlp. **Также они могут находится в** zip-архиве (один файл - один архив).** 4163 + 4164 +В пути указывается **agentId** - id клиента. 4165 + 4166 +**Заголовок** 4167 + 4168 +**X-Auth: [токен авторизации]** 4169 + 4170 +**Параметры** 4171 + 4172 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4173 +|withNoData|Параметр **Объекты без данных**. Определяет способ загрузки объекта, у которого отсутствует имя или модель объекта. true - загружать, false - пропускать. 4174 +|importMethod|Параметр **Метода импорта датчиков**. Определяет метод добавления датчиков импортируемых из файла. Значение: Replace - Замена, Merge - Слияние, Add - Добавление 4175 + 4176 +В теле использовать тип **form-data,** тип значения** file** 4177 + 4178 +**Ключи** 4179 + 4180 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4181 +|data|В значении передаем файл объекта, формат **xml** или **wlp ** 4182 +|csv|В значении передаем файл датчиков, формат **csv** 4183 + 4184 +Ответ: 4185 + 4186 +{ 4187 + "vehicleId": 0, 4188 + "name": "string", 4189 + "errors": ["string"] 4190 +} 4191 + 4192 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4193 +|vehicleId|ID созданного объекта 4194 +|name|Имя созданного объекта 4195 +|errors|Ошибки и их описание 4196 + 4197 +== (% style="color:#000000; font-size:16px" %)**Импорт сообщений**(%%) == 4198 + 4199 +(% class="box infomessage" %) 4200 +((( 4201 +**POST** **/api/v3/vehicles/import/history/{vehicleId}** 4202 +))) 4203 + 4204 +(% class="wikigeneratedid" %) 4205 +Позволяет импортировать сообщения в выбранный объект. Сообщения должны иметь формат **wln** или **json**. Также они могут быть упакованы и переданы в виде в **zip-архива**. 4206 + 4207 +(% class="wikigeneratedid" %) 4208 +В пути указывается **vehicleId **- id объекта. 4209 + 4210 +**Заголовок** 4211 + 4212 +**X-Auth: [токен авторизации]** 4213 + 4214 +В теле использовать тип **form-data.** 4215 + 4216 +Ключи: 4217 + 4218 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4219 +|**history**|В значении передавать файл с историей 4220 + 4221 +В случае, если загружается история из файла **wln **можно выполнять подмену названий параметров. В ключе вы указываете название параметра из файла, в значении указываете значение на которое нужно заменить. 4222 + 4223 +Ответ: 4224 + 4225 +{ 4226 + "results": [ 4227 + { 4228 + "vehicleGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 4229 + "vehicleId": 0, 4230 + "errors": [ 4231 + "string" 4232 + ], 4233 + "firstMessageDate": "2023-11-28T09:27:58.949Z", 4234 + "lastMessageDate": "2023-11-28T09:27:58.949Z", 4235 + "producedCount": 0, 4236 + "msgCount": 0 4237 + } 4238 + ] 4239 +} 4240 + 4241 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4242 +|results|Результаты импорта в разрезе ТС 4243 +|vehicleGuid|Guid ТС 4244 +|vehicleId|ID ТС 4245 +|errors|Список ошибок импорта истории (если пустой - нет ошибок) 4246 +|firstMessageDate|Дата первого импортированного сообщения (UTC) 4247 +|lastMessageDate|Дата последнего импортированного сообщения (UTC) 4248 +|producedCount|Кол-во успешно отправленных в шину данных сообщений 4249 +|msgCount|Кол-во обработанных сообщений всего 4250 + 4251 +== == 4252 + 4253 +== **Импортировать историю ТС (Асинхронный запрос)** == 4254 + 4255 +(% class="box successmessage" %) 4256 +((( 4257 +**POST /api/v3/Vehicles/importAsync/history/{vehicleId} ** 4258 +))) 4259 + 4260 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4261 + 4262 +Метод запроса: **POST** 4263 + 4264 +URL запроса: **https:~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/{vehicleId} ** 4265 + 4266 +Параметр запроса: {**__vehicleid}__** - идентификатор транспортного средства 4267 + 4268 + 4269 +Ответ: 4270 + 4271 +{ 4272 + 4273 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4274 + 4275 + "Status": 0, ~/~/ Перечисление состояний выполнения запроса 4276 + 4277 +~/~/ ( 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest) 4278 + 4279 + "Message": "string", ~/~/ Информация о выполнении запроса 4280 + 4281 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса (1 - Intermediate, 2 - ProgressProcent, 255 - None) 4282 + 4283 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4284 + 4285 + "Data": "string" ~/~/ Данные 4286 + 4287 +} 4288 + 4289 + 4290 +== (% style="color:#000000; font-size:16px" %)**Статус импорта сообщений**(%%) == 4291 + 4292 +(% class="box infomessage" %) 4293 +((( 4294 +**GET /api/v3/vehicles/import/history/status** 4295 +))) 4296 + 4297 +Запрос статуса импорта истории. Может потребоваться в случае импорта истории за большой период. 4298 + 4299 +Ответ: 4300 + 4301 +{ 4302 + "activity": true, 4303 + "progress": 0, 4304 + "message": "string" 4305 +} 4306 + 4307 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)((( 4308 +**Параметр** 4309 +)))|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)((( 4310 +**Описание** 4311 +))) 4312 +|((( 4313 +activity 4314 +)))|((( 4315 +Активен ли экспорт/импорт истории сейчас, true - да, false - нет 4316 +))) 4317 +|((( 4318 +progress 4319 +)))|((( 4320 +Guid ТС 4321 +))) 4322 + 4323 + 4324 +== **Возвращает статус асинхронного запроса импорта истории ТС** == 4325 + 4326 +(% class="box infomessage" %) 4327 +((( 4328 +**GET /api/v3/Vehicles/importAsync/history/state/{requestId}** 4329 +))) 4330 + 4331 +При выгрузке большого объема информации, выполняющихся более 90 секунд, рекомендуется использовать этот запрос. 4332 + 4333 +Метод запроса: **GET** 4334 + 4335 +URL запроса: https:**~/~/hosting.glonasssoft.ru/api/v3/Vehicles/importAsync/history/state/{requestId}** 4336 + 4337 +Параметр запроса: {**requestId__}__** - Уникальный идентификатор запроса 4338 + 4339 + 4340 +Ответ: 4341 + 4342 +{ 4343 + 4344 + "RequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Уникальный идентификатор запроса 4345 + 4346 + "Status": 0, ~/~/ Перечисление состояний выполения запроса 4347 +~/~/ 0 - Success, 1 - InPorgress, 2 - Canceled, 10 - Error, 20 - ErrorRequestValidation, 50 - ErrorExceedMaximumActiveRequest 4348 + 4349 + "Message": "string", ~/~/ Информация о выполнении запроса 4350 + 4351 + "ProgressState": 1, ~/~/ Тип информирования о ходе выполнении запроса 4352 + 4353 +~/~/ 1 - Intermediate, 2 - ProgressProcent, 255 - None 4354 + 4355 + "ProgressValue": 0, ~/~/ Прогресс выполнения запроса. Актуально, только если ProgressState=InProgress 4356 + 4357 + "Data": "string" ~/~/ Данные 4358 + 4359 +} 4360 + 4361 +== (% style="color:#000000; font-size:16px" %)**Экспорт объектов**(%%) == 4362 + 4363 +(% class="box infomessage" %) 4364 +((( 4365 +**POST /api/v3/vehicles/export** 4366 +))) 4367 + 4368 +Запрос позволяет экспортировать файлы с настройками объектов. В запросе передается массив id объектов. 4369 + 4370 +Тело запроса: 4371 + 4372 +[ 4373 + id 4374 +] 4375 + 4376 +Ответ: Success 200, получаете файлы с настройками. 4377 + 4378 +== (% style="color:#000000; font-size:16px" %)**Экспорт сообщений**(%%) == 4379 + 4380 +(% class="box infomessage" %) 4381 +((( 4382 +**POST /api/v3/vehicles/export/history** 4383 +))) 4384 + 4385 +Метод возвращает список сообщений терминала объекта за выбранный период. 4386 + 4387 +Тело запроса: 4388 + 4389 +{ 4390 + "vehicleId": 0, 4391 + "asArchive": true, 4392 + "from": "2023-09-27T12:17:45.973Z", 4393 + "to": "2023-09-27T12:17:45.973Z" 4394 +} 4395 + 4396 +Ответ: 4397 + 4398 +Получаете файл. Сообщение: Code 200/Success 4399 + 4400 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4401 +|vehicleId|ID объекта 4402 +|asArchive|true - Архивировать файл, False - не архивировать 4403 +|from|Дата и время начала запроса 4404 +|to|Дата и время окончания запроса 4405 + 4406 +== (% style="color:#000000; font-size:16px" %)**Статус экспорта сообщений**(%%) == 4407 + 4408 +(% class="box infomessage" %) 4409 +((( 4410 +**GET /api/v3/vehicles/export/history/status** 4411 +))) 4412 + 4413 +Метод возвращает список сообщений терминала объекта за выбранный период. 4414 + 4415 +Ответ: 4416 + 4417 +{ 4418 + "activity": true, 4419 + "progress": 0, 4420 + "message": "string" 4421 +} 4422 + 4423 +|=(% style="width: 215px; background-color: rgb(230, 230, 230);" %)**Параметр**|=(% style="width: 861px; background-color: rgb(230, 230, 230);" %)**Описание** 4424 +|activity|Статус экспорта, где true - экспорт в процессе выполнения, false - в данный момент ничего не экспортируется. 4425 +|progress|Прогресс экспорта, от 0 до 100% 4426 +|message|Текст описывающий статус 4427 + 4428 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Экодрайвинг**(%%) = 4429 + 4430 +== (% style="color:#000000; font-size:16px" %)**Запрос рейтинга качества вождения**(%%) == 4431 + 4432 +(% class="box infomessage" %) 4433 +((( 4434 +**POST /api/v3/EcoDriving/rating** 4435 +))) 4436 + 4437 +Позволяет получить данные рейтинга нарушений выбранных объектов за указанный период времени. Данные, выдаваемые этим запросом аналогичны тем, что вы можете увидеть в окне **Качество вождения** в мониторинге. В массиве **items **передается список объектов из рейтинга качества вождения, в **trips **передается информация по отдельным рейсам объекта. 4438 + 4439 +Тело запроса: 4440 + 4441 +{ 4442 + "vehicleIds": [vehicleId], ~/~/Массив ID объектов 4443 + "from": "2023-11-22T09:29:48.051Z", ~/~/ Дата начала запроса 4444 + "to": "2023-11-22T09:29:48.051Z" ~/~/ Дата окончания запроса 4445 +} 4446 + 4447 +Ответ: 4448 + 4449 +{ 4450 + "items": [ ~/~/ Список в разрезе ТС 4451 + { 4452 + "from": "2023-11-22T09:29:48.052Z", ~/~/ Дата начала периода 4453 + "to": "2023-11-22T09:29:48.052Z", ~/~/ Дата окончания периода 4454 + "vehicleId": 0, ~/~/ ID ТС 4455 + "vehicleName": "string", ~/~/ Название ТС 4456 + "vehicleModel": "string", ~/~/ Модель ТС 4457 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов в разрезе ТС 4458 + "score": 0, ~/~/ Рассчитанная оценка вождения в разрезе ТС 4459 + "totalViolations": 0, ~/~/ Нарушений всего 4460 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4461 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4462 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4463 + "brakingViolations": 0, ~/~/ Нарушений торможения 4464 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4465 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4466 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4467 + }, 4468 + 4469 +((( 4470 + 4471 +))) 4472 + 4473 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4474 + "mileage": 0, ~/~/ Пробег, м 4475 + "tripsCount": 0, ~/~/ Кол-во рейсов 4476 + "trips": [ ~/~/ Информация по рейсу 4477 + { 4478 + "penalty": 0, ~/~/ Кол-во рассчитанных штрафных баллов за рейс 4479 + "score": 0, ~/~/ Рассчитанная оценка вождения за рейс 4480 + "violationsCount": 0, ~/~/ Всего нарушений 4481 + "violationsByType": { ~/~/ Информация о нарушениях по типу 4482 + "overspeedingViolations": 0, ~/~/ Нарушений превышения скорости 4483 + "accelerationViolations": 0, ~/~/ Нарушений ускорения 4484 + "brakingViolations": 0, ~/~/ Нарушений торможения 4485 + "turningViolations": 0, ~/~/ Нарушений опасного поворота 4486 + "dangerousDrivingViolations": 0, ~/~/ Нарушений резкого вождения 4487 + "sensorViolations": 0 ~/~/ Нарушений по датчику 4488 + }, 4489 + 4490 + "startDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата начала поездки 4491 + "endDate": "2024-11-18T13:23:38.516Z", ~/~/ Дата окончания поездки 4492 + "moveTime": 0, ~/~/ Продолжительность движения, сек 4493 + "mileage": 0, ~/~/ Пробег, м 4494 + "motohours": 0, ~/~/ Моточасы, секунды 4495 + "maxSpeed": 0, ~/~/ Максимальная скорость за рейс 4496 + "startAddress": "string", ~/~/ Адрес начала рейса 4497 + "endAddress": "string", ~/~/ Адрес конца рейса 4498 + "drivers": [ ~/~/ Список водителей 4499 + { 4500 + "driverGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/GUID водителя 4501 + "driverName": "string", ~/~/ФИО водителя 4502 + "driverRfid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/GUID радиометки 4503 + } 4504 + ] 4505 + } 4506 + ] 4507 + } 4508 + ] 4509 +} 4510 + 4511 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Топливные карты**(%%) = 4512 + 4513 +== (% style="color:#000000; font-size:16px" %)**Запрос транзакций по топливным картам**(%%) == 4514 + 4515 +Транзакции по топливным картам можно получить при наличии права «Транзакции ТК». Метод позволяет получить транзакции по нескольким топливным картам. 4516 + 4517 +(% class="box infomessage" %) 4518 +((( 4519 +**POST /api/v3/fuelcards/transactions** 4520 +))) 4521 + 4522 +Метод запроса: POST 4523 + 4524 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards/transactions 4525 +\\В заголовках запроса: X-Auth: Токен авторизации 4526 + 4527 +Параметры в теле запроса (JSON): 4528 + 4529 +{ 4530 + "startDate": "2024-04-11T10:32:02.395Z", ~/~/ Начало периода 4531 + "endDate": "2024-04-11T10:32:02.395Z", ~/~/ Конец периода 4532 + "ids": [ 4533 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификаторы топливных карт 4534 + ], 4535 + "timezone": 0 ~/~/ Часовой пояс 4536 +} 4537 + 4538 + 4539 +Ответ: 4540 + { 4541 + "date": "2024-04-11T10:41:02.265Z", ~/~/ Дата и время транзакции 4542 + "driver": "string", ~/~/ Водители, привязанные к ТК 4543 + "object": "string", ~/~/ Наименование ТС 4544 + "amount": 0, ~/~/ Количество топлива 4545 + "amountDut": 0, ~/~/ Количество по ДУТ 4546 + "amountDiff": 0, ~/~/ Разница, л 4547 + "amountDiffPerc": 0, ~/~/ Разница, % 4548 + "summa": 0, ~/~/ Стоимость, руб 4549 + "serviceName": "string", ~/~/ Тип топлива 4550 + "price": 0, ~/~/ Цена за литр, руб 4551 + "cardName": "string", ~/~/ Наименование ТК 4552 + "cardNum": "string", ~/~/ Номер ТК 4553 + "operator": "string", ~/~/ Оператор ТК 4554 + "address": "string" ~/~/ Адрес АЗС 4555 + } 4556 + 4557 +== (% style="color:#000000; font-size:16px" %)**Получение списка топливных карт**(%%) == 4558 + 4559 +(% class="box infomessage" %) 4560 +((( 4561 +**GET /api/v3/fuelcards** 4562 +))) 4563 + 4564 +Метод запроса: GET 4565 + 4566 +URL запроса: https:~/~/hosting.glonasssoft.ru/api/v3/fuelcards?ownerId=ID_клиента ~/~/ ID клиента у которого нужно запросить список 4567 + 4568 +Ответ: 4569 + 4570 +[ 4571 + { 4572 + "Name": "string", ~/~/ Определяет наименование карты. 4573 + "OperatorGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Определяет идентификатор оператора. 4574 + "Number": "string", ~/~/ Определяет № карты. 4575 + "Enabled": true, ~/~/ Определяет признак активности карты. 4576 + "Description": "string", ~/~/ Определяет описание карты. 4577 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID карты 4578 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 4579 + "deleted": true ~/~/ Признак удаления 4580 + } 4581 +] 4582 + 4583 += (% style="color:#000000; font-size:18.6667px" %)Раздел: (%%)**Методы публичного API для ретрансляторов** = 4584 + 4585 + 4586 +== **Получение полных данных о ретрансляторе** == 4587 + 4588 +(% class="box infomessage" %) 4589 +((( 4590 +**GET ** **/api/v3/retranslations/{id}** 4591 +))) 4592 + 4593 +id - Идентификатор ретранслятора 4594 + 4595 + 4596 +Пример ответа: 4597 + 4598 +{ 4599 +"description": "", ~/~/ Поле описания ретранслятора 4600 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4601 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4602 +"isEnabled": true, ~/~/ Признак включения ретранслятора, Включен, true - включен, false - отключен 4603 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4604 +"objects": [ ~/~/ Объекты для ретрансляции 4605 +{ 4606 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4607 +"name": "", ~/~/ Наименование объекта ретрансляции 4608 +"imei": "", ~/~/ IMEI объекта ретрансляции 4609 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4610 +} 4611 + ], 4612 +"id": "", ~/~/ Идентификатор ретранслятора 4613 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4614 +"deleted": "" ~/~/ Признак удаления ретранслятора: true - включен, false - отключен 4615 +} 4616 + 4617 + 4618 +== **Удаление данных ретранслятора** == 4619 + 4620 +(% class="box infomessage" %) 4621 +((( 4622 +**DELETE** **/api/v3/retranslations/{id}** 4623 +))) 4624 + 4625 +id - Идентификатор ретранслятора 4626 + 4627 + 4628 +== **Создание ретранслятора** == 4629 + 4630 +(% class="box infomessage" %) 4631 +((( 4632 +**POST ** **/api/v3/retranslations/{id}** 4633 +))) 4634 + 4635 +Запрос: 4636 + 4637 +{ 4638 +"description": "", ~/~/ Поле описания ретранслятора 4639 +"subscriberId": "", ~/~/ Идентификатор подписчика 4640 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4641 +"address": "", ~/~/ Адрес и порт принимающего сервера 4642 +"isEnabled": "", ~/~/ Признак включения ретранслятора, true - включен, false - отключен 4643 +"objects": [ ~/~/Объекты для ретрансляции 4644 +{ 4645 +"id": "", ~/~/ Идентификатор ретранслятора 4646 +"imei": "", ~/~/ IMEI объекта ретрансляции 4647 +"isEnabled": "" ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4648 +} 4649 + ] 4650 +} 4651 + 4652 + 4653 +Ответ: 4654 + 4655 +{ 4656 +"description": "", ~/~/ Поле описания ретранслятора 4657 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4658 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4659 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4660 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4661 +"objects": [ ~/~/ Объекты для ретрансляции 4662 +{ 4663 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4664 +"name": "string", ~/~/ Наименование объекта ретрансляции 4665 +"imei": "", ~/~/ IMEI объекта ретрансляции 4666 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4667 +} 4668 + ], 4669 +"id": "", ~/~/ Идентификатор ретранслятора 4670 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4671 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4672 +} 4673 + 4674 + 4675 +== **Редактирование ретранслятора** == 4676 + 4677 +(% class="box infomessage" %) 4678 +((( 4679 +**PUT** **/api/v3/retranslations** 4680 +))) 4681 + 4682 +Пример запроса: 4683 + 4684 +{ 4685 +"id": "", ~/~/ Идентификатор ретранслятора 4686 +"description": "string", ~/~/ Поле описания ретранслятора 4687 +"subscriberId": "", ~/~/ Идентификатор подписчика 4688 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4689 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4690 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4691 +"objects": ~/~/ Объекты для ретрансляции 4692 +[ 4693 +{ 4694 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4695 +"imei": "", ~/~/ IMEI объекта ретрансляции 4696 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4697 +} 4698 + ] 4699 +} 4700 + 4701 + 4702 +Пример ответа: 4703 + 4704 +{ 4705 +"description": "", ~/~/ Поле описания ретранслятора 4706 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4707 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4708 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4709 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4710 +"objects": [ ~/~/ Объекты для ретрансляции 4711 +{ 4712 +"id": "", ~/~/ Идентификатор объекта ретрансляции 4713 +"name": "string", ~/~/ Наименование объекта ретрансляции 4714 +"imei": "", ~/~/ IMEI объекта ретрансляции 4715 +"isEnabled": true ~/~/ Признак включения объекта ретрансляции: true - включен, false - отключен 4716 +} 4717 + ], 4718 +"id": "", ~/~/ Идентификатор ретранслятора 4719 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4720 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4721 +} 4722 + 4723 + 4724 +== **Получение списка ретранслятора клиента** == 4725 + 4726 +(% class="box infomessage" %) 4727 +((( 4728 +**POST /api/v3/retranslations/find** 4729 +))) 4730 + 4731 +Пример запроса: 4732 + 4733 +{ 4734 +"id": "", ~/~/ Идентификатор ретранслятора 4735 +"search": "string", ~/~/ Строка поиска. Поиск производится по имени подписчика, описанию, типу протокола и адресу 4736 +"parentId": "" ~/~/ Идентификатор родительского агента, для которого надо получить данные (обязательный параметр). 4737 +} 4738 + 4739 +Ответ: 4740 + 4741 +[ 4742 +{ 4743 +"description": "", ~/~/ Поле описания ретранслятора 4744 +"subscriberId": "", ~/~/ Идентификатор подписчика (клиента, чьи объекты будут ретранслироваться) 4745 +"protocolType": 0, ~/~/ Тип протокола ретрансляции 4746 +"isEnabled": true, ~/~/ Признак включения ретранслятора: true - включен, false - отключен 4747 +"address": "string", ~/~/ Адрес и порт принимающего сервера 4748 +"id": "", ~/~/ Идентификатор ретранслятора 4749 +"parentId": "", ~/~/ Идентификатор родителя (вышестоящего клиента) 4750 +"deleted": true ~/~/ Признак удаления ретранслятора: true - удален, false - не удален 4751 +} 4752 +] 4753 + 4754 + 4755 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Отчеты**(%%) = 4756 + 4757 +== **API для отчета по выгрузке комбайнов** == 4758 + 4759 +(% class="box infomessage" %) 4760 +((( 4761 +**POST /api/v3/Reports/harvesterUnloading** 4762 +))) 4763 + 4764 +Пример запроса: 4765 + 4766 +{ 4767 + "byTime": 0, ~/~/ Объединение событий по времени 4768 + "byDist": 0, ~/~/ Объединение событий по расстоянию 4769 + "filterByTime": 0, ~/~/ Фильтрация событий по времени нахождения 4770 + "filterByHalfPerimeter": true, ~/~/ Фильтрация событий по пробегу половины периметра 4771 + "showNearestObjects": true, ~/~/Показывать объекты рядом? 4772 + "vehicleIds": [ ~/~/ Список id объектов для анализа 4773 + 0 4774 + ], 4775 + "from": "", ~/~/ Дата и время начало запроса 4776 + "to": "", ~/~/ Дата и время окончания запроса 4777 + "timezone": 0 ~/~/ Временная зона. Если не указана, то по умолчанию UTC+3 4778 +} 4779 + 4780 +Пример ответа: 4781 + 4782 +[ 4783 + { 4784 + "harvesterName": "", ~/~/Комбайн, номер 4785 + "harvesterId": 0, ~/~/Комбайн, id 4786 +"harvesterModel": "", ~/~/ Модель комбайна 4787 +"hopperCapacity": 0, ~/~/ Объем бункера м3 4788 + "hopperDischargeSpeed": 0, ~/~/ Скорость выгрузки из бункера, л/сек 4789 + "events": [ ~/~/Список событий в разрезе комбайна 4790 + { 4791 + "driverId": "", ~/~/Идентификатор водителя 4792 + "driverName": "", ~/~/Водитель комбайна, ФИО 4793 + "RFID": "", ~/~/ идентификатор карты-метки 4794 + "rfidName": "", ~/~/Водитель комбайна, имя метки 4795 + "vehicleId": 0, ~/~/идентификатор объекта 4796 + "vehicleName": "string", ~/~/ Имя объекта 4797 + "modelName": "string", ~/~/ Имя модели объекта 4798 + "nearestVehicles": [ ~/~/Объекты рядом 4799 + { 4800 + "vehicleId": 0, ~/~/идентификатор объекта 4801 + "vehicleName": "string" ~/~/ Имя объекта 4802 + } 4803 + ], 4804 + "fields": [ ~/~/Поля, где происходила выгрузка 4805 + { 4806 + "id": 0, ~/~/ идентификатор пользователя 4807 + "name": "string" ~/~/ имя пользователя 4808 + } 4809 + ], 4810 + "event": "string", ~/~/Событие 4811 + "start": "2024-07-19T06:41:57.821Z", ~/~/ Начало периода 4812 + "end": "2024-07-19T06:41:57.821Z", ~/~/ Окончание периода 4813 + "durationSeconds": 0, ~/~/Продолжительность события, в секундах 4814 + "cultureName": "string", ~/~/ название культуры 4815 + "bunkerLowLevelStart": 0, ~/~/Бункер, нижний уровень (на начало события) 4816 + "bunkerLowLevelEnd": 0, ~/~/ Бункер, нижний уровень (на конец события) 4817 + "bunkerHighLevelStart": 0, ~/~/Бункер, верхний уровень (на начало события) 4818 + "bunkerHighLevelEnd": 0, ~/~/Бункер, верхний уровень (на конец события) 4819 + "reapingAggregateValueStart": 0, ~/~/Жатка (на начало события) 4820 + "reapingAggregateValueEnd": 0, ~/~/Жатка (на конец события) 4821 + "issued": 0, ~/~/Выдано, бункеров 4822 + "issuedByBunkerSensors": 0, ~/~/Отдано бункеров (расчет по датчикам бункера) 4823 + "latitude": 0, ~/~/Широта 4824 + "longitude": 0, ~/~/ Долгота 4825 + "litresAway": 0, ~/~/Отдано, л 4826 + "m3Away": 0 ~/~/Отдано, м3 4827 + } 4828 + ] 4829 + } 4830 +] 4831 + 4832 + 4833 +== **Отчет трек-датчики** == 4834 + 4835 +(% class="box infomessage" %) 4836 +((( 4837 +**POST /api/v3/Reports/sensorsWorks** 4838 +))) 4839 + 4840 +**Пример запроса:** 4841 + 4842 +{ 4843 + "vehicleIds": [ ~/~/ Список ID объектов 4844 + 0 4845 + ], 4846 + "from": "2025-02-20T06:39:23.888Z", ~/~/ Начало периода (локальное время клиента) 4847 + "to": "2025-02-20T06:39:23.888Z", ~/~/ Конец периода (локальное время клиента) 4848 + "timezone": 0 ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4849 +} 4850 + 4851 +**Пример ответа:** 4852 + 4853 +((( 4854 +{ 4855 + "vehicleSensorWorks": [ ~/~/ Интервалы работы оборудования для конкретного ТС 4856 + { 4857 + "vehicleId": 0, ~/~/ Идентификатор ТС 4858 + "sensorWorks": [ ~/~/ Интервалы работы оборудования. 4859 + { 4860 + "start": "2025-02-20T06:39:23.979Z", ~/~/ Начало интервала работы оборудования. 4861 + "end": "2025-02-20T06:39:23.979Z", ~/~/ Конец интервала работы оборудования. 4862 + "duration": 0, ~/~/ Продолжительность интервала в секундах. 4863 + "name": "string", ~/~/ Наименование оборудования. 4864 + "mileage": 0, ~/~/ Пробег за время работы оборудования. 4865 + "totalMileage": 0, ~/~/ Общий пробег. 4866 + "avgSpeed": 0 ~/~/ Средняя скорость. 4867 + } 4868 + ] 4869 + } 4870 + ] 4871 +} 4872 + 4873 + 4874 +== **Превышение скорости** == 4875 + 4876 +(% class="box infomessage" %) 4877 +((( 4878 +**POST /api/v3/Reports/overSpeedDuration** 4879 +))) 4880 + 4881 + Публичный API запрос о превышениях скорости по объекту в секундах с выбором способа определения нарушений (дорожное ограничение или фиксированное ограничение). 4882 + 4883 +Пример запроса: 4884 + 4885 +((( 4886 +{ 4887 + "vehicleId": 0, ~/~/ идентификационный номер транспортного средства 4888 + "from": "2025-04-21T10:45:25.258Z", ~/~/ Начало периода (локальное время клиента) 4889 + "to": "2025-04-21T10:45:25.258Z", ~/~/ Конец периода (локальное время клиента) 4890 + "timezone": 0, ~/~/ Таймзона клиента, в часах (double). Если не передана - то считается как +3, MSK 4891 + "overSpeedDetectionType": 0 ~/~/ тип нарушения (1-дорожное ограничение, 2-фиксированный ) 4892 +} 4893 +))) 4894 + 4895 +((( 4896 + 4897 +))) 4898 + 4899 +((( 4900 +Пример ответа: 4901 +))) 4902 + 4903 +((( 4904 +((( 4905 +[ 4906 + { 4907 + "eventDate": "2025-04-21T10:45:25.267Z", ~/~/ Дата и время события 4908 + "duration": 0, ~/~/ Продолжительность события в секундах 4909 + "maxSpeed": 0, ~/~/ Максимальная скорость 4910 + "speedLimit": 0 ~/~/ Ограничение скорости 4911 + } 4912 +] 4913 +))) 4914 +))) 4915 +))) 4916 + 4917 += (% style="color:#000000; font-size:18.6667px" %)**Раздел: Сельскохозяйственные поля **(%%) = 4918 + 4919 + 4920 +== **Запрос списка полей** == 4921 + 4922 +(% class="box successmessage" %) 4923 +((( 4924 +**POST /api/v3/agroLands/find** 4925 +))) 4926 + 4927 +Пример запроса: 4928 + 4929 +((( 4930 +((( 4931 +((( 4932 +{ 4933 + "year": 0, ~/~/ Фильтр по году 4934 + "name": "string", ~/~/ Фильтр по названию 4935 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Фильтр по подразделению 4936 +} 4937 +))) 4938 +))) 4939 + 4940 + 4941 +))) 4942 + 4943 +Пример ответа: 4944 + 4945 +((( 4946 +[ 4947 + { 4948 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 4949 + "year": 0, ~/~/ Год поля 4950 + "startDate": "2024-12-20T12:27:07.523Z", ~/~/ Начало года урожая 4951 + "endDate": "2024-12-20T12:27:07.523Z", ~/~/ Конец года урожая 4952 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 4953 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 4954 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 4955 + "counts": { ~/~/ Счётчики с/х поля 4956 + "fieldOperations": 0, ~/~/ Количество операций на поле 4957 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 4958 + "facts": 0 ~/~/ Счётчик факта 4959 + }, 4960 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4961 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4962 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4963 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 4964 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 4965 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 4966 + "planComment": "string", ~/~/ Комментарий к полю 4967 + "productivity": 0, ~/~/ Урожайность. 4968 + "id": 0, ~/~/ Идентификатор объекта геозоны 4969 + "name": "string", ~/~/ Название объекта геозоны 4970 + "type": 0, ~/~/ Тип объекта геозоны 4971 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 4972 + "fname": "string", ~/~/ Имя файла 4973 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 4974 + "beginCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата начала расчетов для геозоны 4975 + "endCalc": "2024-12-20T12:27:07.523Z", ~/~/ Дата окончания расчетов для геозоны 4976 + "description": "string", ~/~/ Описание объекта геозоны 4977 + "area": 0, ~/~/ Площадь, м2 4978 + "perimetr": 0, ~/~/ Периметр, м 4979 + "createDate": "2024-12-20T12:27:07.523Z" ~/~/ Дата создания в бд 4980 + } 4981 +] 4982 + 4983 + 4984 +== **Создание нового поля ** == 4985 + 4986 +(% class="box successmessage" %) 4987 +((( 4988 +**POST /api/v3/agroLands** 4989 +))) 4990 + 4991 +Если необходимо указывать конкретного клиента, в котором нужно создать поле, то в заголовке надо прописать 4992 +X-agent - ID клиента 4993 + 4994 +Пример запроса: 4995 + 4996 +((( 4997 +{ 4998 + "extId": "string", 4999 + "shape": "{\"type\":\"Polygon\",\"coordinates\":~[~[[50.299112,54.769317],[50.299369,54.76691],[50.303702,54.767878],[50.299112,54.769317]]]}", ~/~/ Форма поля 5000 + "shapeFormat": "geojson", ~/~/ Формат, в котором представлена форма поля 5001 + "display": "string", ~/~/ Настройки отображения 5002 + "year": 0, ~/~/ Год поля 5003 + "name": "string", ~/~/ Наименование 5004 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5005 + "startDate": "2024-12-20T08:19:59.635Z", ~/~/ Начало года урожая 5006 + "endDate": "2024-12-20T08:19:59.635Z", ~/~/ Конец года урожая 5007 + "planComment": "string", ~/~/ Комментарий к полю 5008 + "cropRotations": [ ~/~/ Данные по севообороту 5009 + { 5010 + "landId": 0, ~/~/ ID поля 5011 + "landName": "string", ~/~/ Название поля 5012 + "year": 0, ~/~/ Год урожая 5013 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5014 + "cultureName": "string", ~/~/ Название культуры 5015 + "productivity": 0, ~/~/ Урожайность 5016 + "area": 0, ~/~/ Площадь поля, Га 5017 + "total": 0, ~/~/ Валовый сбор 5018 + "productivityFact": 0, ~/~/ Фактическая урожайность 5019 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5020 + "totalFact": 0, ~/~/ Фактический валовый сбор 5021 + "start": "2024-12-20T08:19:59.635Z", ~/~/ Дата начала работ 5022 + "sowing": "2024-12-20T08:19:59.635Z", ~/~/ Дата сева 5023 + "harvesting": "2024-12-20T08:19:59.635Z", ~/~/ Дата уборки урожая 5024 + "isyearplan": true, ~/~/ Годовой план 5025 + "comment": "string" ~/~/ Комментарий 5026 + } 5027 + ] 5028 +} 5029 +))) 5030 + 5031 +((( 5032 + 5033 +))) 5034 + 5035 +Пример ответа: 5036 + 5037 +((( 5038 +((( 5039 +{ 5040 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5041 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5042 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5043 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5044 + "cropRotations": [ ~/~/ Данные по севообороту 5045 + { 5046 + "landId": 0, ~/~/ ID поля 5047 + "landName": "string", ~/~/ Название поля 5048 + "year": 0, ~/~/ Год урожая 5049 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5050 + "cultureName": "string", ~/~/ Название культуры 5051 + "productivity": 0, ~/~/ Урожайность 5052 + "area": 0, ~/~/ Площадь поля, Га. 5053 + "total": 0, ~/~/ Валовый сбор 5054 + "productivityFact": 0, ~/~/ Фактическая урожайность 5055 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5056 + "totalFact": 0, ~/~/ Фактический валовый сбор 5057 + "start": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала работ 5058 + "sowing": "2024-12-20T08:19:59.743Z", ~/~/ Дата сева 5059 + "harvesting": "2024-12-20T08:19:59.743Z", ~/~/ Дата уборки урожая 5060 + "isyearplan": true, ~/~/ годовой план 5061 + "comment": "string" ~/~/ Комментарий 5062 + } 5063 + ], 5064 + "cropVegetation": [ ~/~/ История вегетации поля 5065 + { 5066 + "values": [ ~/~/ Данные вегетации и состояния посева 5067 + { 5068 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5069 + "ndvi": 0 ~/~/ Индекс вегетации 5070 + } 5071 + ], 5072 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5073 + { 5074 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5075 + "type": "string", ~/~/ Тип 5076 + "pictureid": "string" ~/~/ Идентификатор ресурса 5077 + } 5078 + ], 5079 + "states": [ ~/~/ Ключевые даты развития поля 5080 + { 5081 + "date": "2024-12-20T08:19:59.743Z", ~/~/ Дата 5082 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5083 + } 5084 + ] 5085 + } 5086 + ], 5087 + "endDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата закрытия года урожая 5088 + "counts": { 5089 + "fieldOperations": 0, ~/~/ Количество операций на поле 5090 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5091 + "facts": 0 ~/~/ Счётчик факта 5092 + }, 5093 + "planComment": "string", ~/~/ Комментарий к полю 5094 +))) 5095 + 5096 +((( 5097 + "productivity": 0, ~/~/ Урожайность. 5098 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5099 + "startDate": "2024-12-20T08:19:59.743Z", ~/~/ Дата открытия года урожая 5100 + "year": 0, ~/~/ Год поля 5101 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5102 + "actualPlanState": 0, ~/~/ Актуальный статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5103 + "factState": 0, ~/~/ Фактический статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5104 + "taskState": 0, ~/~/ Статус задачи годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5105 + "status": 0, ~/~/ Статус с/х поля 0 - Нет, 1 - Открыто, 2 - Закрыто 5106 + "id": 0, ~/~/ Идентификатор объекта геозоны 5107 + "name": "string", ~/~/ Название объекта геозоны 5108 + "type": 0, ~/~/ Тип объекта геозоны 5109 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5110 + "fname": "string", ~/~/ Имя файла 5111 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5112 + "beginCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата начала расчетов для геозоны 5113 + "endCalc": "2024-12-20T08:19:59.743Z", ~/~/ Дата окончания расчетов для геозоны 5114 + "description": "string", ~/~/ Описание объекта геозоны 5115 + "area": 0, ~/~/ Площадь, м2 5116 + "perimetr": 0, ~/~/ Периметр, м 5117 + "createDate": "2024-12-20T08:19:59.743Z" ~/~/ Дата создания в бд 5118 +} 5119 + 5120 + 5121 +))) 5122 +))) 5123 +))) 5124 + 5125 +== **Получение поля по id** == 5126 + 5127 +(% class="box infomessage" %) 5128 +((( 5129 +**GET /api/v3/agroLands/{id}** 5130 +))) 5131 + 5132 +Пример запроса: 5133 +id ~/~/ Идентификатор поля 5134 + 5135 +Пример ответа: 5136 + 5137 +((( 5138 +{ 5139 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5140 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5141 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5142 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5143 + "cropRotations": [ ~/~/ Данные по севообороту 5144 + { 5145 + "landId": 0, ~/~/ ID поля 5146 + "landName": "string", ~/~/ Название поля 5147 + "year": 0, ~/~/ Год урожая 5148 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5149 + "cultureName": "string", ~/~/ Название культуры 5150 + "productivity": 0, ~/~/ Урожайность 5151 + "area": 0, ~/~/ Площадь поля, Га 5152 + "total": 0, ~/~/ Валовый сбор 5153 + "productivityFact": 0, ~/~/ Фактическая урожайность 5154 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5155 + "totalFact": 0, ~/~/ Фактический валовый сбор 5156 + "start": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала работ 5157 + "sowing": "2024-12-20T07:45:52.611Z", ~/~/ Дата сева 5158 + "harvesting": "2024-12-20T07:45:52.611Z", ~/~/ Дата уборки урожая 5159 + "isyearplan": true, ~/~/ План года 5160 + "comment": "string" ~/~/ Комментарий 5161 + } 5162 + ], 5163 + "cropVegetation": [ ~/~/ История вегетации поля 5164 + { 5165 + "values": [ ~/~/ Данные вегетации и состояния посева 5166 + { 5167 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5168 + "ndvi": 0 ~/~/ Индекс вегетации 5169 + } 5170 + ], 5171 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5172 + { 5173 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5174 + "type": "string", ~/~/ Тип 5175 + "pictureid": "string" ~/~/ Идентификатор ресурса 5176 + } 5177 + ], 5178 + "states": [ ~/~/ Ключевые даты развития поля 5179 + { 5180 + "date": "2024-12-20T07:45:52.611Z", ~/~/ Дата 5181 + "state": 0 ~/~/ Статус 0 - Посев, 1 - Всходы, 2 - Сбор урожая 5182 + } 5183 + ] 5184 + } 5185 + ], 5186 + "endDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата закрытия года урожая 5187 + "counts": { 5188 + "fieldOperations": 0, ~/~/ Количество операций на поле 5189 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5190 + "facts": 0 ~/~/ Счётчик факта 5191 + }, 5192 + "planComment": "string", ~/~/ Комментарий к полю 5193 + "productivity": 0, ~/~/ Урожайность. 5194 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5195 +))) 5196 + 5197 +((( 5198 +((( 5199 + "startDate": "2024-12-20T07:45:52.611Z", ~/~/ Дата открытия года урожая 5200 + "year": 0, ~/~/ Год поля 5201 + "planState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5202 + "actualPlanState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5203 + "factState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5204 + "taskState": 0, ~/~/ Статус годового планирования участка (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5205 + "status": 0, ~/~/ Статус с/х поля (0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой) 5206 + "id": 0, ~/~/ Идентификатор объекта геозоны 5207 + "name": "string", ~/~/ Название объекта геозоны 5208 + "type": 0, ~/~/ Тип объекта геозоны 5209 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5210 + "fname": "string", ~/~/ Имя файла 5211 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5212 + "beginCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата начала расчетов для геозоны 5213 + "endCalc": "2024-12-20T07:45:52.611Z", ~/~/ Дата окончания расчетов для геозоны 5214 + "description": "string", ~/~/ Описание объекта геозоны 5215 + "area": 0, ~/~/ Площадь, м2 5216 + "perimetr": 0, ~/~/ Периметр, м 5217 + "createDate": "2024-12-20T07:45:52.611Z" ~/~/ Дата создания в бд 5218 +} 5219 +))) 5220 + 5221 + 5222 +== **Удаление существующего поля** == 5223 + 5224 +(% class="box errormessage" %) 5225 +((( 5226 +**DELETE /api/v3/agroLands/{id}** 5227 +))) 5228 + 5229 +Пример запроса: 5230 +id ~/~/ Идентификатор поля 5231 + 5232 +Пример ответа: 5233 + 5234 +((( 5235 +200 ~/~/ Успех 5236 +))) 5237 + 5238 +((( 5239 + 5240 +))) 5241 + 5242 +((( 5243 +((( 5244 +((( 5245 + 5246 +))) 5247 + 5248 +((( 5249 +== **Изменение поля** == 5250 + 5251 +(% class="box infomessage" %) 5252 +((( 5253 +**PUT /api/v3/agroLands** 5254 +))) 5255 + 5256 +Пример запроса: 5257 + 5258 +((( 5259 +((( 5260 +{ 5261 + "id": 0, ~/~/ Идентификатор поля 5262 + "extId": "string", ~/~/ ExtId 5263 + "shape": "string", ~/~/ Форма поля 5264 + "shapeFormat": "string", ~/~/ Формат, в котором представлена форма поля 5265 + "display": "string", ~/~/ Настройки отображения 5266 + "year": 0, ~/~/ Год поля 5267 + "name": "string", ~/~/ Наименование 5268 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5269 + "startDate": "2024-12-20T10:11:59.425Z", ~/~/ Начало года урожая 5270 + "endDate": "2024-12-20T10:11:59.425Z", ~/~/ Конец года урожая 5271 + "planComment": "string", ~/~/Комментарий к полю 5272 + "cropRotations": [ ~/~/ Данные по севообороту 5273 + { 5274 + "landId": 0, ~/~/ ID поля 5275 + "landName": "string", ~/~/ Название поля 5276 + "year": 0, ~/~/ Год урожая 5277 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5278 + "cultureName": "string", ~/~/ Название культуры 5279 + "productivity": 0, ~/~/ Урожайность 5280 + "area": 0, ~/~/ Площадь поля, Га. 5281 + "total": 0, ~/~/ Валовый сбор 5282 + "productivityFact": 0, ~/~/ Фактическая урожайность 5283 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5284 + "totalFact": 0, ~/~/ Фактический валовый сбор 5285 + "start": "2024-12-20T10:11:59.425Z", ~/~/ Дата начала работ 5286 + "sowing": "2024-12-20T10:11:59.425Z", ~/~/ Дата сева 5287 + "harvesting": "2024-12-20T10:11:59.425Z", ~/~/ Дата уборки урожая 5288 + "isyearplan": true, 5289 + "comment": "string" ~/~/ Комментарий 5290 + } 5291 + ], 5292 + "deleteStatistic": true ~/~/ Нужно ли удалять статистику 5293 +} 5294 +))) 5295 +))) 5296 + 5297 +((( 5298 + 5299 +))) 5300 + 5301 +Пример ответа: 5302 + 5303 +((( 5304 +((( 5305 +((( 5306 +{ 5307 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5308 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5309 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5310 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5311 + "cropRotations": [ ~/~/ Данные по севообороту 5312 + { 5313 + "landId": 0, ~/~/ ID поля 5314 + "landName": "string", ~/~/ Название поля 5315 + "year": 0, ~/~/ Год урожая 5316 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5317 + "cultureName": "string", ~/~/ Название культуры 5318 + "productivity": 0, ~/~/ Урожайность 5319 + "area": 0, ~/~/ Площадь поля, Га 5320 + "total": 0, ~/~/ Валовый сбор 5321 + "productivityFact": 0, ~/~/ Фактическая урожайность 5322 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5323 + "totalFact": 0, ~/~/ Фактический валовый сбор 5324 + "start": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала работ 5325 + "sowing": "2024-12-20T10:11:59.533Z", ~/~/ Дата сева 5326 + "harvesting": "2024-12-20T10:11:59.533Z", ~/~/ Дата уборки урожая 5327 + "isyearplan": true, ~/~/ 5328 + "comment": "string" ~/~/ Комментарий 5329 + } 5330 + ], 5331 + "cropVegetation": [ ~/~/ История вегетации поля 5332 + { 5333 + "values": [ ~/~/ Данные вегетации и состояния посева 5334 + { 5335 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5336 + "ndvi": 0 ~/~/ Индекс вегетации 5337 + } 5338 + ], 5339 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5340 + { 5341 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5342 + "type": "string", ~/~/ Тип 5343 + "pictureid": "string" ~/~/ Идентификатор ресурса 5344 + } 5345 + ], 5346 + "states": [ ~/~/ Ключевые даты развития поля 5347 + { 5348 + "date": "2024-12-20T10:11:59.533Z", ~/~/ Дата 5349 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5350 + } 5351 + ] 5352 + } 5353 + ], 5354 + "endDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата закрытия года урожая 5355 + "counts": { 5356 + "fieldOperations": 0, ~/~/ Количество операций на поле 5357 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5358 + "facts": 0 ~/~/ Счётчик факта 5359 + }, 5360 + "planComment": "string", ~/~/ Комментарий к полю 5361 + "productivity": 0, ~/~/ Урожайность. 5362 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5363 + "startDate": "2024-12-20T10:11:59.533Z", ~/~/ Дата открытия года урожая 5364 + "year": 0, ~/~/ Год поля 5365 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5366 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5367 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5368 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто Частично С ошибкой 5369 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5370 + "id": 0, ~/~/ Идентификатор объекта геозоны 5371 + "name": "string", ~/~/ Название объекта геозоны 5372 + "type": 0, ~/~/ Тип объекта геозоны 5373 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5374 + "fname": "string", ~/~/ Имя файла 5375 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5376 + "beginCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата начала расчетов для геозоны 5377 + "endCalc": "2024-12-20T10:11:59.533Z", ~/~/ Дата окончания расчетов для геозоны 5378 + "description": "string", ~/~/ Описание объекта геозоны 5379 + "area": 0, ~/~/ Площадь, м2 5380 + "perimetr": 0, ~/~/ Периметр, м 5381 + "createDate": "2024-12-20T10:11:59.533Z" ~/~/ Дата создания в бд 5382 +} 5383 +))) 5384 +))) 5385 +))) 5386 +))) 5387 +))) 5388 + 5389 + 5390 +== **Редактирование года урожая ** == 5391 + 5392 +(% class="box successmessage" %) 5393 +((( 5394 +**POST /api/v3/agroLands/updateOpenCloseYear** 5395 +))) 5396 + 5397 +Пример запроса: 5398 + 5399 +((( 5400 +((( 5401 +{ 5402 + "agroLandIds": [ ~/~/ Идентификаторы полей для которых меняется год урожая 5403 + 0 5404 + ], 5405 + "newStartDate": "2024-12-20T11:43:43.921Z", ~/~/ Новая дата начала урожая 5406 + "newEndDate": "2024-12-20T11:43:43.921Z" ~/~/ Новая дата закрытия урожая 5407 +} 5408 +))) 5409 + 5410 + 5411 +))) 5412 + 5413 +Пример ответа: 5414 + 5415 +((( 5416 +((( 5417 +{ 5418 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор культуры 5419 + "cultureTechnologyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор технологии 5420 + "fieldId": 0, ~/~/ Ссылка на группирующее с/х поле 5421 + "sourceId": 0, ~/~/ Ссылка на участок прошлого года 5422 + "cropRotations": [ ~/~/ Данные по севообороту 5423 + { 5424 + "landId": 0, ~/~/ ID поля 5425 + "landName": "string", ~/~/ Название поля 5426 + "year": 0, ~/~/ Год урожая 5427 + "cultureId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID культуры 5428 + "cultureName": "string", ~/~/ Название культуры 5429 + "productivity": 0, ~/~/ Урожайность 5430 + "area": 0, ~/~/ Площадь поля, Га. 5431 + "total": 0, ~/~/ Валовый сбор 5432 + "productivityFact": 0, ~/~/ Фактическая урожайность 5433 + "areaFact": 0, ~/~/ Фактическая площадь поля, Га. 5434 + "totalFact": 0, ~/~/ Фактический валовый сбор 5435 + "start": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала работ 5436 + "sowing": "2024-12-20T11:43:44.091Z", ~/~/ Дата сева 5437 + "harvesting": "2024-12-20T11:43:44.091Z", ~/~/ Дата уборки урожая 5438 + "isyearplan": true, ~/~/ 5439 + "comment": "string" ~/~/ Комментарий 5440 + } 5441 + ], 5442 + "cropVegetation": [ ~/~/ История вегетации поля 5443 + { 5444 + "values": [ ~/~/ Данные вегетации и состояния посева 5445 + { 5446 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5447 + "ndvi": 0 ~/~/ Индекс вегетации 5448 + } 5449 + ], 5450 + "resources": [ ~/~/ Данные о снимках для каждого значения NDVI 5451 + { 5452 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5453 + "type": "string", ~/~/ Тип 5454 + "pictureid": "string" ~/~/ Идентификатор ресурса 5455 + } 5456 + ], 5457 + "states": [ ~/~/ Ключевые даты развития поля 5458 + { 5459 + "date": "2024-12-20T11:43:44.091Z", ~/~/ Дата 5460 + "state": 0 ~/~/ Статус 0 - Всходы, 1 - Вершина, 2 - Сбор урожая 5461 + } 5462 + ] 5463 + } 5464 + ], 5465 + "endDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата закрытия года урожая 5466 + "counts": { 5467 + "fieldOperations": 0, ~/~/ Количество операций на поле 5468 + "actualFieldOperations": 0, ~/~/ Кол-во актуальных операций на поле 5469 + "facts": 0 ~/~/ Счётчик факта 5470 + }, 5471 + "planComment": "string", ~/~/ Комментарий к полю 5472 + "productivity": 0, ~/~/ Урожайность. 5473 + "sqPlan": 0, ~/~/ Определяет площадь поля, Га. 5474 + "startDate": "2024-12-20T11:43:44.091Z", ~/~/ Дата открытия года урожая 5475 + "year": 0, ~/~/ Год поля 5476 + "planState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5477 + "actualPlanState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5478 + "factState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5479 + "taskState": 0, ~/~/ Статус годового планирования участка 0 - Нет, 1 - Запланированная, 2 - Запланированная ошибка, 3 - Ошибка закрытия, 4 - Закрыто, 5 - Отменено, 6 - Закрыто частично, 7 - Закрыто частично с ошибкой 5480 + "status": 0, ~/~/ Статус с/х поля 0 - нет, 1 - открыто, 2 - закрыто 5481 + "id": 0, ~/~/ Идентификатор объекта геозоны 5482 + "name": "string", ~/~/ Название объекта геозоны 5483 + "type": 0, ~/~/ Тип объекта геозоны 5484 + "unitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Подразделение 5485 + "fname": "string", ~/~/ Имя файла 5486 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента 5487 + "beginCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата начала расчетов для геозоны 5488 + "endCalc": "2024-12-20T11:43:44.091Z", ~/~/ Дата окончания расчетов для геозоны 5489 + "description": "string", ~/~/ Описание объекта геозоны 5490 + "area": 0, ~/~/ Площадь, м2 5491 + "perimetr": 0, ~/~/ ериметр, м 5492 + "createDate": "2024-12-20T11:43:44.091Z" ~/~/ Дата создания в бд 5493 +} 5494 +))) 5495 + 5496 + 5497 += (% style="color:#000000; font-size:18.6667px" %)Раздел: **Корзина**(%%) = 5498 +))) 5499 +))) 5500 +))) 5501 + 5502 +== (% style="color:#000000; font-size:16px" %)**Запрос на получение списка всех объектов в корзине**(%%) == 5503 + 5504 + 5505 +(% class="box infomessage" %) 5506 +((( 5507 +**GET api/v3/Vehicles/recyclebin/all** 5508 +))) 5509 + 5510 +Метод возвращает полную информацию о списках всех объектов в корзине по пользователям, доступным агенту 5511 + 5512 +Параметр запроса: {parentId} - идентификатор агента 5513 + 5514 +В заголовках запроса: X-Auth: Токен авторизации 5515 + 5516 +Ответ: 5517 + 5518 +[ 5519 + { 5520 + "recordTime": "", ~/~/Время записи 5521 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5522 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5523 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5524 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5525 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5526 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5527 + "items": [ ~/~/ 5528 +nullable: true ~/~/Детали 5529 + { 5530 + "name": "string", ~/~/наименование столбца 5531 + "value": "string" ~/~/содержание столбца 5532 + } 5533 + ] 5534 + }, 5535 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5536 + "string" 5537 + ] 5538 + } 5539 +] 5540 + 5541 + 5542 +== (% style="color:#000000; font-size:16px" %)**Запрос на удаление объектов из корзины**(%%) == 5543 + 5544 +(% class="box infomessage" %) 5545 +((( 5546 +**POST api/v3/Vehicles/recyclebin/erase** 5547 +))) 5548 + 5549 +В заголовках запроса: X-Auth: Токен авторизации 5550 + 5551 +Пример запроса: 5552 + 5553 +[ 5554 +0 5555 +] 5556 + 5557 + 5558 +Пример ответа: 5559 + 5560 +[ 5561 +{ 5562 + "recordTime": "", ~/~/Время записи 5563 + "userId": "", ~/~/Guid пользователя, добавившего объект в корзину 5564 + "parentId": "", ~/~/Guid агента объекта, помещённого в корзину 5565 + "objectId": 0, ~/~/ID объекта, помещённого в корзин 5566 + "objectGuid": "", ~/~/Guid объекта, помещённого в корзину 5567 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5568 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5569 + "items": [ ~/~/Детали 5570 + { 5571 + "name": "", ~/~/Имя свойства 5572 + "value": "" ~/~/Значение свойства 5573 + } 5574 + ] 5575 + }, 5576 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5577 + "" 5578 + ] 5579 + } 5580 +] 5581 + 5582 +Ответ: В случае успешного выполнения запроса вернется HTTP ответ «200». 5583 + 5584 +== (% style="color:#000000; font-size:16px" %)**Запрос на восстановление объектов из корзины**(%%) == 5585 + 5586 +(% class="box infomessage" %) 5587 +((( 5588 +**POST api/v3/Vehicles/recyclebin/restore** 5589 +))) 5590 + 5591 +В заголовках запроса: X-Auth: Токен авторизации 5592 + 5593 +Параметры в теле запроса (JSON): 5594 + 5595 +Восстанавливает объекты из корзины. Возвращает те объекты которые не получилось восстановить. 5596 + 5597 +В заголовках запроса: X-Auth: Токен авторизации 5598 + 5599 + 5600 +Пример запроса: 5601 + 5602 +((( 5603 +[ 5604 +))) 5605 + 5606 +((( 5607 + 0 5608 +))) 5609 + 5610 +((( 5611 +] 5612 +))) 5613 + 5614 + 5615 +Пример ответа: 5616 + 5617 +[ 5618 +{ 5619 + "recordTime": "2024-07-19T07:58:19.305Z", ~/~/Время записи 5620 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid пользователя, добавившего объект в корзину 5621 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid агента объекта, помещённого в корзину 5622 + "objectId": 0, ~/~/ID объекта, помещённого в корзину 5623 + "objectGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/Guid объекта, помещённого в корзину 5624 + "objectType": 1, ~/~/Тип объекта, помещённого в корзину 5625 + "details": { ~/~/Список деталей объекта, помещённого в корзину 5626 + "items": [ ~/~/Детали 5627 + { 5628 + "name": "string", ~/~/Имя свойства 5629 + "value": "string" ~/~/Значение свойства 5630 + } 5631 + ] 5632 + }, 5633 + "errors": [ ~/~/Список ошибок удаления/восстановления объекта 5634 + "string" 5635 + ] 5636 + } 5637 +] 5638 + 5639 + 5640 += **Раздел: Журнал заданий ** = 5641 + 5642 + 5643 +== **Создание задания в Журнале заданий** == 5644 + 5645 +(% class="box infomessage" %) 5646 +((( 5647 +**POST /api/v3/vehicletasks** 5648 +))) 5649 + 5650 +Пример запроса: 5651 + 5652 +((( 5653 +{ 5654 + "vehicleId": 0, ~/~/ Идентификатор ТС 5655 + "description": "string", ~/~/ Описание 5656 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5657 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5658 + "startDate": "2025-02-25T12:11:04.874Z", ~/~/ Начало работы 5659 + "endDate": "2025-02-25T12:11:04.874Z", ~/~/ Окончание работы 5660 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5661 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5662 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5663 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5664 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5665 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5666 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5667 + "cost": { 5668 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5669 + "Name": "string", ~/~/ Наименование 5670 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection ) 5671 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5672 + "Norm": 0 ~/~/ Норма внесения 5673 + }, 5674 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id 5675 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5676 + "created": "2025-02-25T12:11:04.874Z", ~/~/ Дата создания 5677 + "updated": "2025-02-25T12:11:04.874Z", ~/~/ Дата обновления 5678 + "deleted": true, ~/~/ Признак удаления 5679 + "extId": "string", 5680 + "GeoIds": [ ~/~/ Cвязанные поля 5681 + 0 5682 + ] 5683 +} 5684 +))) 5685 + 5686 + 5687 +Пример ответа: 5688 + 5689 +{ 5690 + "vehicleId": 0, ~/~/ Идентификатор ТС 5691 + "description": "string", ~/~/ Описание 5692 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5693 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5694 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5695 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5696 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5697 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5698 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5699 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5700 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5701 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5702 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5703 + "cost": { 5704 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5705 + "Name": "string", ~/~/ Наименование 5706 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5707 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5708 + "Norm": 0 ~/~/ Норма внесения 5709 + }, 5710 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5711 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5712 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5713 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5714 + "deleted": true, ~/~/ Признак удаления 5715 + "extId": "string", ~/~/ ExtId 5716 + "GeoIds": [ ~/~/ Связанные поля 5717 + 0 5718 + ] 5719 +} 5720 + 5721 + 5722 +== **Редактирование задания в Журнале заданий** == 5723 + 5724 +(% class="box successmessage" %) 5725 +((( 5726 +**PUT /api/v3/vehicletasks** 5727 +))) 5728 + 5729 +Пример запроса: 5730 + 5731 +((( 5732 +{ 5733 + "vehicleId": 0, ~/~/ Идентификатор ТС 5734 + "description": "string", ~/~/ Описание 5735 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5736 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5737 + "startDate": "2025-02-25T12:25:51.090Z", ~/~/ Начало работы 5738 + "endDate": "2025-02-25T12:25:51.090Z", ~/~/ Окончание работы 5739 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5740 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5741 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5742 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5743 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5744 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5745 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5746 + "cost": { 5747 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5748 + "Name": "string", ~/~/ Наименование 5749 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5750 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5751 + "Norm": 0 ~/~/ Норма внесения 5752 + }, 5753 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5754 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5755 + "created": "2025-02-25T12:25:51.090Z", ~/~/ Дата создания 5756 + "updated": "2025-02-25T12:25:51.090Z", ~/~/ Дата обновления 5757 + "deleted": true, ~/~/ Признак удаления 5758 + "extId": "string", ~/~/ ExtId 5759 + "GeoIds": [ ~/~/ Связанные поля 5760 + 0 5761 + ] 5762 +} 5763 +))) 5764 + 5765 + 5766 +Пример ответа: 5767 + 5768 +{ 5769 + "vehicleId": 0, ~/~/ Идентификатор ТС 5770 + "description": "string", ~/~/ Описание 5771 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5772 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5773 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5774 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5775 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5776 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5777 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5778 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5779 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5780 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5781 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5782 + "cost": { 5783 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5784 + "Name": "string", ~/~/ Наименование 5785 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5786 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5787 + "Norm": 0 ~/~/ Норма внесения 5788 + }, 5789 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5790 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5791 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5792 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5793 + "deleted": true, ~/~/ Признак удаления 5794 + "extId": "string", ~/~/ ExtId 5795 + "GeoIds": [ ~/~/ Связанные поля 5796 + 0 5797 + ] 5798 +} 5799 + 5800 + 5801 +== **Удаление задания в Журнале заданий** == 5802 + 5803 +(% class="box warningmessage" %) 5804 +((( 5805 +**DELETE /api/v3/vehicletasks** 5806 +))) 5807 + 5808 +Пример запроса: 5809 + 5810 +((( 5811 +[ 5812 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор 5813 +] 5814 +))) 5815 + 5816 +((( 5817 + 5818 +))) 5819 + 5820 +Пример ответа: 5821 + 5822 +{ 5823 + "vehicleId": 0, ~/~/ Идентификатор ТС 5824 + "description": "string", ~/~/ Описание 5825 + "trailerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агрегата 5826 + "driverId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор водителя 5827 + "startDate": "2025-02-25T12:11:04.964Z", ~/~/ Начало работы 5828 + "endDate": "2025-02-25T12:11:04.964Z", ~/~/ Окончание работы 5829 + "techOperationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Вид работ 5830 + "techOperationDataId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Тех. операция 5831 + "trailerModelId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Модель агрегата 5832 + "minWidth": 0, ~/~/ Минимальная ширина агрегата, м 5833 + "maxWidth": 0, ~/~/ Максимальная ширина агрегата, м 5834 + "minSpeed": 0, ~/~/ Минимальная скорость, км/ч 5835 + "maxSpeed": 0, ~/~/ Максимальная скорость, км/ч 5836 + "cost": { 5837 + "Guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор 5838 + "Name": "string", ~/~/ Наименование 5839 + "Type": 0, ~/~/ Тим ТМЦ (0 - Seed, 1 - Crop, 2 - Fertilizer, 3 - PlantProtection) 5840 + "MeasureType": 0, ~/~/ Единицы измерения (0 - Кг, 1 - Тонн, 2 - Центнеры, 3 - Литры) 5841 + "Norm": 0 ~/~/ Норма внесения 5842 + }, 5843 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 5844 + "owner": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Guid родителя 5845 + "created": "2025-02-25T12:11:04.964Z", ~/~/ Дата создания 5846 + "updated": "2025-02-25T12:11:04.964Z", ~/~/ Дата обновления 5847 + "deleted": true, ~/~/ Признак удаления 5848 + "extId": "string", ~/~/ ExtId 5849 + "GeoIds": [ ~/~/ Связанные поля 5850 + 0 5851 + ] 5852 +} 5853 + 5854 + 5855 +== **Получение списка Журнала заданий** == 5856 + 5857 +(% class="box infomessage" %) 5858 +((( 5859 +**POST /api/v3/vehicletasks/getbyperiod** 5860 +))) 5861 + 5862 +Пример запроса: 5863 + 5864 +((( 5865 +{ 5866 + "Start": "2025-02-25T12:35:31.107Z", ~/~/ Начало периода. 5867 + "End": "2025-02-25T12:35:31.107Z", ~/~/ Окончание периода. 5868 + "TimeZone": 0, ~/~/ Часовой пояс. 5869 + "OperationsIds": [ ~/~/ Идентификаторы видов работ для фильтрации журнала 5870 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" 5871 + ], 5872 + "GeoIds": [ ~/~/ Идентификаторы полей для фильтрации журнала 5873 + 0 5874 + ], 5875 + "VehiclesIds": [ ~/~/ Идентификаторы ТС для фильтрации журнала 5876 + 0 5877 + ], 5878 + "Offset": 0, ~/~/ Смещение от начала результата. Количество записей журнала для пропуска. 5879 + "Limit": 0 ~/~/ Размер страницы (количество записей на странице) 5880 +} 5881 +))) 5882 + 5883 + 5884 +Пример ответа: 5885 + 5886 +((( 5887 +{ 5888 + "total": 0, ~/~/ Общее количество записей 5889 + "pages": 0, ~/~/ Общее количество страниц 5890 + "currentPage": 0, ~/~/ Текущая страница 5891 + "items": [ ~/~/ Записи 5892 + { 5893 + "taskId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5894 + "isGroup": true, ~/~/ Вид задания (true - групповое, иначе - одиночное). 5895 + "name": "string", ~/~/ Название задания. 5896 + "startDate": "2025-02-25T12:35:31.110Z", ~/~/ Начало, utc 5897 + "endDate": "2025-02-25T12:35:31.110Z", ~/~/ Окончание, utc 5898 + "workKind": "string", ~/~/ Вид работ 5899 + "techOp": "string", ~/~/ Тех. операция 5900 + "trailerModel": "string", ~/~/ Модель агрегата 5901 + "width": "string", ~/~/ Ширина, м 5902 + "speed": "string", ~/~/ Тех. скорость 5903 + "fields": "string", ~/~/ Поля 5904 + "fieldsInfo": "string", ~/~/ Количество полей (суммарная площадь га) 5905 + "vehicles": "string", ~/~/ Объект-модель 5906 + "vehiclesCount": 0, ~/~/ Объектов (суммарное количество объектов) 5907 + "drivers": "string", ~/~/ Водители 5908 + "tmc": "string", ~/~/ ТМЦ 5909 + "client": "string", ~/~/ Клиент 5910 + "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор задания 5911 + "dep": "string", ~/~/ Подразделение 5912 + "geoIds": [ ~/~/ Связанные поля 5913 + 0 5914 + ] 5915 + } 5916 + ] 5917 +} 5918 +))) 5919 + 5920 + 5921 += **Раздел: Локатор ** = 5922 + 5923 + 5924 +== **Получение списка локаторов, доступных пользователю ** == 5925 + 5926 +(% class="box infomessage" %) 5927 +((( 5928 +**GET /api/v3/locators** 5929 +))) 5930 + 5931 +В заголовках запроса: X-Auth: Токен авторизации 5932 + 5933 + 5934 +Пример ответа: 5935 + 5936 +((( 5937 +[ 5938 + { 5939 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора. 5940 + "agentGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор агента. 5941 + "agentName": "string", ~/~/ Наименование агента. 5942 + "isEnabled": true, ~/~/ Активен 5943 + "created": "2025-03-12T06:48:41.254Z", ~/~/ Дата создания 5944 + "updated": "2025-03-12T06:48:41.254Z", ~/~/ Дата обновления 5945 + "name": "string", ~/~/ Наименование 5946 + "status": 0, ~/~/ 5947 + "activationMode": 0, ~/~/ Определяет статус пользователя локатора (0 - Активный, 1 - Запланированный, 2 - Неактивный) 5948 + "activationTime": "2025-03-12T06:48:41.254Z", ~/~/ Определяет вид активации локаторов. ( 0 - сейчас, 1 - время активации) 5949 + "validity": 0, ~/~/ Срок действия в днях (1-90). 5950 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5951 + "creatorUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID пользователя, создавшего локатор. 5952 + "creatorUserName": "string", ~/~/ Имя пользователя, создавшего локатор. 5953 + "url": "string", ~/~/ Ссылка 5954 + "language": 0, ~/~/ Язык. 5955 + "vehiclesCount": 0, ~/~/ Количество объектов. 5956 + "geozonesCount": 0, ~/~/ Количество геозон. 5957 + "fieldsCount": 0 ~/~/ Количество полей. 5958 + } 5959 +] 5960 +))) 5961 + 5962 + 5963 + 5964 +== **Создание локатора** == 5965 + 5966 +(% class="box successmessage" %) 5967 +((( 5968 +**POST /api/v3/locators** 5969 +))) 5970 + 5971 +Пример запроса: 5972 + 5973 +((( 5974 +{ 5975 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 5976 + "isEnabled": true, ~/~/ Активность 5977 + "name": "string", ~/~/ Наименование локатора 5978 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - Сейчас, 1 - Запустить ко времени) 5979 + "activationTime": "2025-03-12T07:00:08.272Z", ~/~/ Время активации 5980 + "validity": 0, ~/~/ Срок действия в днях (1-90) 5981 + "autoProlongation": true, ~/~/ Автопродление срока действия. 5982 + "url": "string", ~/~/ Ссылка 5983 + "language": 0 ~/~/ Язык 5984 +} 5985 +))) 5986 + 5987 + 5988 +Пример ответа: 5989 + 5990 +((( 5991 +3fa85f64-5717-4562-b3fc-2c963f66afa6 ~/~/ Идентификатор локатора 5992 +))) 5993 + 5994 + 5995 + 5996 +== **Изменение локатора** == 5997 + 5998 +(% class="box infomessage" %) 5999 +((( 6000 +**PUT /api/v3/locators** 6001 +))) 6002 + 6003 +Пример запроса: 6004 + 6005 +((( 6006 +{ 6007 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор локатора 6008 + "isEnabled": true, ~/~/ Активность 6009 + "name": "string", ~/~/ Наименование 6010 + "activationMode": 0, ~/~/ Определяет вид активации локаторов (0 - сейчас, 1 - Запустить ко времени ) 6011 + "activationTime": "2025-03-12T07:07:53.002Z", ~/~/ Время активации 6012 + "validity": 0, ~/~/ Срок действия в днях (1-90) 6013 + "autoProlongation": true, ~/~/ Автопродление срока действия 6014 + "url": "string", ~/~/ Ссылка 6015 + "language": 0 ~/~/ Язык 6016 +} 6017 +))) 6018 + 6019 + 6020 +Пример ответа: 6021 + 6022 +200 ~/~/ Success 6023 + 6024 + 6025 +== **Удалить локатор** == 6026 + 6027 +(% class="box warningmessage" %) 6028 +((( 6029 +**DELETE /api/v3/locators** 6030 +))) 6031 + 6032 +Пример запроса: 6033 + 6034 +((( 6035 +[ 6036 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Идентификатор локатора 6037 +] 6038 +))) 6039 + 6040 + 6041 + 6042 += **Раздел: Яндекс Маршруты** = 6043 + 6044 + 6045 +== **Возвращение списка маршрутов** == 6046 + 6047 +(% class="box infomessage" %) 6048 +((( 6049 +**GET /api/v3/TransportRoutes** 6050 +))) 6051 + 6052 +Пример запроса: 6053 +Id ~/~/ Идентификатор поля 6054 + 6055 + 6056 +Пример ответа: 6057 + 6058 +((( 6059 +[ 6060 + { 6061 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ id 6062 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6063 + "name": "string", ~/~/ Наименование маршрута. 6064 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6065 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6066 + 0 6067 + ] 6068 + } 6069 +] 6070 +))) 6071 + 6072 + 6073 + 6074 +== **Добавить маршрут** == 6075 + 6076 +(% class="box infomessage" %) 6077 +((( 6078 +**POST /api/v3/TransportRoutes** 6079 +))) 6080 + 6081 +Пример запроса: 6082 +{ 6083 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6084 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6085 + "kind": 0, ~/~/ Определяет вид маршрута. (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6086 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6087 + 0 6088 + ] 6089 +} 6090 + 6091 + 6092 +Пример ответа: 6093 + 6094 +((( 6095 +{ 6096 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6097 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6098 + "name": "string", ~/~/ Определяет наименование маршрута 6099 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6100 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6101 + 0 6102 + ] 6103 +} 6104 +))) 6105 + 6106 + 6107 +== **Обновление маршрута** == 6108 + 6109 +(% class="box successmessage" %) 6110 +((( 6111 +**PUT /api/v3/TransportRoutes** 6112 +))) 6113 + 6114 +Пример запроса: 6115 + 6116 +((( 6117 +{ 6118 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6119 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6120 + "name": "string", ~/~/ Опредлеляет наименование маршрута. 6121 + "kind": 0, ~/~/ Определяет вид маршрута (0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water) 6122 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6123 + 0 6124 + ] 6125 +} 6126 +))) 6127 + 6128 + 6129 +Пример ответа: 6130 + 6131 +((( 6132 +{ 6133 + "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ ID 6134 + "parentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Id записи к которой принадлежит маршрут 6135 + "name": "string", ~/~/ Определяет наименование маршрута 6136 + "kind": 0, ~/~/ Определяет вид маршрута ( 0 - Bus, 1 - Trolley, 2 - Tram, 3 - Taxi, 4 - Water ) 6137 + "vehicles": [ ~/~/ Определяет список ТС для маршрута 6138 + 0 6139 + ] 6140 +} 6141 +))) 6142 + 6143 + 6144 +== **Получить связки маршрутов ТС** == 6145 + 6146 +(% class="box infomessage" %) 6147 +((( 6148 +**POST /api/v3/TransportRoutes/getroutesvehicles** 6149 +))) 6150 + 6151 +Пример запроса: 6152 + 6153 +((( 6154 +[ 6155 + "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ идентификатор маршрута 6156 +] 6157 +))) 6158 + 6159 + 6160 +Пример ответа: 6161 + 6162 +((( 6163 +[ 6164 + { 6165 + "vehicleId": 0, ~/~/ Опредлеляет идентификатор ТС 6166 + "routeGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6" ~/~/ Определяет идентификатор маршрута 6167 + } 6168 +] 6169 +))) 6170 + 6171 + 6172 +== **Удалить маршрут** == 6173 + 6174 +(% class="box warningmessage" %) 6175 +((( 6176 +**DELETE /api/v3/TransportRoutes/{id}** 6177 +))) 6178 + 6179 +Пример запроса: 6180 +Id ~/~/ Идентификатор поля 6181 + 6182 + 6183 +==== ==== 6184 + 6185 += **Раздел: Управление доступа к машинам** = 6186 + 6187 + 6188 +== Получение списка транспортных средств видимых пользователю == 6189 + 6190 +(% class="box infomessage" %) 6191 +((( 6192 +**GET /api/v3/UserVisibleVehicles/{userId}** 6193 +))) 6194 + 6195 +Пример ответа: 6196 + 6197 +((( 6198 +{ 6199 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6200 + 0 6201 + ] 6202 +} 6203 +))) 6204 + 6205 + 6206 + 6207 +== Задает видимость транспортных средств пользователю == 6208 + 6209 +(% class="box infomessage" %) 6210 +((( 6211 +**POST /api/v3/UserVisibleVehicles** 6212 +))) 6213 + 6214 +Пример запроса: 6215 + 6216 +((( 6217 +((( 6218 +{ 6219 + "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", ~/~/ Идентификатор пользователя 6220 + "vehicleIds": [ ~/~/ Идентификаторы ТС 6221 + 0 6222 + ] 6223 +} 6224 +))) 6225 + 6226 +((( 6227 + 6228 +))) 6229 + 6230 +((( 6231 + 6232 +))) 6233 + 6234 +((( 6235 +Пример ответа : 6236 +))) 6237 + 6238 +((( 6239 + 6240 +))) 6241 + 6242 +((( 6243 +200 ~/~/ Success 6244 +))) 6245 +))) 6246 + 6247 + 6248 + 6249 + 6250 + 6251 + 3356 3356 (% class="box" lang="en-US" style="text-align: center;" %) 3357 3357 ((( 3358 3358 (% lang="ru-RU" style="color:#000000; font-family:Liberation Serif,serif; font-size:14pt; font-style:normal; font-variant:normal" %)**По вопросам работы PUBLIC API 3.0 можно обращаться**(% lang="ru-RU" style="color:#000000; font-size:14pt" %)** на [[support@glonasssoft.ru>>mailto:support@glonasssoft.ru]] **
- image-20231020124453-1.png
-
- Author
-
... ... @@ -1,0 +1,1 @@ 1 +XWiki.krainovim - Size
-
... ... @@ -1,0 +1,1 @@ 1 +268.0 KB - Content